Get Started

Assuming, you already read about this, like the idea and want to use. This section focuses on setting up and getting started the template on your machine.

Getting the template

With GitHub Templates

You can create your remote repo on GitHub using this template. Navigate to my GitHub repository and click "Use This Template" button.

Name your repo and clone it.

Or clone directly

git clone git@github.com:shreyas-jadhav/next-architecture-template.git

Running Locally

  1. Install Packages
npm i
  1. Run Development Server (This might not work yet, see Configure section)
npm run dev

Configure

  1. Create a copy of example.env and name it .env.local

  2. Variable names are self explanatory and you can add your own config. (This template uses Google Auth. See Next Auth Docs for how to get google credentials)

  3. Changing App Name and other details. Navigate to client/config/appConfig/index.ts to configure things like App Title, emails, etc.