This project is a clone of hacker news rewritten with universal JavaScript, using React and GraphQL. It is intended to be an example or boilerplate to help you structure your projects using production-ready technologies.
Overview
Featuring
-
React - (UI Framework)
-
GraphQL - (Web Data API)
-
Apollo - (GraphQL Client/Server)
-
Next - (Routing, SSR, Hot Module Reloading, Code Splitting, Build tool uses Webpack)
-
TypeScript - (Static Types)
-
Webpack - (Module Bundler)
-
PostCSS - (CSS Processing)
-
Node.js - (Web Server)
-
Express - (Web App Server)
-
Passport - (Authentication)
-
TSLint - (JS Best Practices/Code Highlighting)
-
Jest - (Tests)
-
Docker - (Container Deployment)
-
Optional - Yarn or Pnpm Package Manager - (Better Dependencies)
Benefits
Front End
- Declarative UI - (react)
- Static Typing (typescript)
- GraphQL Fragment Colocation - (react-apollo)
- Prefetch Page Assets - (next)
Server
- Universal JS - (node & express)
- Declarative GraphQL Schema - (apollo-server)
- GraphQL Query Batching - (apollo-server-express)
- GraphQL Stored Queries - (apollo-server-express)
- Easy GraphiQL Include - (apollo-server-express)
- Local Authentication Strategy - (passport)
- Server Side Rendering - (next)
- Code Splitting - (next)
- Build to Static Website - (next)
- Container Based Runtime - (docker)
Dev/Test
- Hot Module Reloading - (next)
- Snapshot Testing - (jest)
- GraphQL Playground
- Faster Package Install - (yarn)
- JS Best Practices - (tslint)
Architecture Overview
Server.js is the entry point. It uses Express and passes requests to Next. Next SSR renders the pages using getInitialProps() hook from Apollo helper. Therefore the app makes GraphQL requests on the client or server.
When the client receives the page it preloads next page JS designated with <Link prefetch href="/">. When the client navigates to the linked page it only needs to make a GraphQL query to render. Great!
See more: Next.js,
Apollo GraphQL Client
GraphQL: GraphQL-Tools by Apollo
or
GraphQL docs
Directory Structure
Each directory contains a README.
root - Only contains config files such as Babel, ESLint, Docker, Flow, NPM, Yarn, Git.
How To Start
One Click Download & Run
You can download and run the repo with one command to rule them all:
git clone https://github.com/clintonwoo/hackernews-react-graphql.git && cd hackernews-react-graphql && npm install && npm run dev
Setup
Running the app in dev mode is fully featured including hot module reloading:
npm install
npm run dev
To run in production mode:
npm run build && npm start
Configuration
The project runs out of the box with default settings (/src/config.js). You can include a .env file in your project root to configure settings (this is the 'dotenv' npm package). The .env file is included in .gitignore.
How To Test
Jest
npm test
This project uses Jest and can do snapshot testing of React components. Whenever a component is changed, please update the snapshots using npm test -- -u or jest --updateSnapshot.
How To Build For Deployment
npm run build: NextJS app with entry point server.js that uses Node.js/Express. Uses Babel compiler to transpile project src to build.
OR
npm run build-docker
Docker Container: Builds a docker container using Dockerfile.
Static Website (Optional)
NextJS lets us make a powerful static website but you need to consider if you need server side rendering.
npm run build-static-website: Builds static website to /build/static. Use a static web server eg. NGINX/Github Pages.
Contributing
Pull requests are welcome. File an issue for ideas, conversation or feedback.
Community
After you ★Star this project, follow @ClintonDAnnolfo on Twitter.
