NextJs Github

This project is a simple github interface using ReactJs on top of Zeit NextJs

Running the project

• Install all project dependencies with npm install
• Start the development server with npm run dev

Github API Authentication (opitional)

This project will consume github API even if you skip this step. If you skip this step, github API will limit requests.

• Create a .env file on application root
• Add github CLIENT_ID and CLIENT_SECRET

    CLIENT_ID=xxxxxxxxxxxxxxxxx
    CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxx

Testing

• Testing without coverage npm test
• Testing with coverage npm run test:coverage
• Testing with watch npm run test:watch

Linting and Conventions

• This project uses eslint with custom airbnb config as a lint tool, to start lint run npm run lint
• This project uses Commitizen git convention, to commit with right conventions run npm run commit
• This project uses a concise timeline, all code pushed to master should be rebased

Building

• To build the project for production run npm run build