Basic project template that makes it easier to be more productive right out the gate.
By default this template uses yarn
for package management. This is not required to use but yarn offers a bit of a performance increase over npm
. You can install yarn from here: https://yarnpkg.com/
First step is to install the required deps:
yarn install
You'll need to make a copy of the example environment file into your local .env
file (please read more about this here: Environment Variables)
cp .env.example .env
During your initial setup process, you will need to ensure that your DB is setup properly.
- The first thing you need to do is get your Docker container setup and started:
yarn dev:docker
- Run your migrations by using the following command:
yarn db:migrate:dev
You should now be able to start the dev environment fully. This will concurrently start your Docker container and NextJS server.
yarn dev
The new project should now be available on: localhost:3000
The core foundation of the template is built with the following:
The rest of the stuff listed was used to implement the features included in the template:
- Auth with NextAuth.js
- Authenticated routes and data.
- Pre-configured Next.js API routes