Meow 🐈‍⬛

A NextJS for a beautified experience on managing Github notifications.

Running locally 🔖

Before you start, you will need:

• Git
• Node.js
• Yarn

Once ready, install all the dependencies:

$ yarn

Then create an environment file from the example file:

$ cp example.env.local env.local

• GITHUB_CLIENT_ID: Obtained when creating an OAuth App in Github
• GITHUB_CLIENT_SECRET: Obtained when creating an OAuth App in Github
• NEXTAUTH_SECRET: get it from here

Note ⚠️  : When creating an OAuth app in Github make sure you mark https://localhost:3000/api/oauth/callback as the callback URL. You can learn more about OAuth here.

Finally run the development server:

$ yarn dev

Now lets open the app by visiting localhost:3000 on your browser.

You can run the integration tests like so:

# Integration tests with Cypress
$ yarn test:int
# Unit tests with Jest
$ yarn test:unit

Other interesting commands:

# Lint the codebase
$ yarn lint
# Check type correctness
$ yarn types
# Check the design system
$ yarn brand:docs

Refer to the NextJS docs if you hit any issues.

Stack 🧱

• Tailwind
• NextJS
• NextAuth
• React Query