This is a Next.js project bootstrapped with create-next-app
.
git clone
- cd into the directory on your computer
- run
npm i
to install node modules - To run the development server run:
npm run dev
# or
yarn dev
- Open http://localhost:3000 with your browser to see the result.
- You can do
npm run test
to run tests in cypress - To access postgres database.
- Copy the .env.example file in the root directory to .env(which will be ignored by Git):
cp .env.example .env
- DATABASE_URL should point to your local database and be in the form
postgres://<user>:<password>@localhost:<PORT>/<database_name>
- Change the permissions of the automated two Bash scripts (scripts/db:setup and scripts/db:build) to make them executable:
chmod +x ./scripts/your-filename
. - Run these via npm scripts:
npm run db:setup
andnpm run db:build
- Configure your local environment Add details for one or more providers (e.g. Google, Twitter, GitHub, Email, etc)or an Auth0 account SIGN UP and add secrets to .env file. Set up an Auth0 account If you haven't already signed up for an Auth0 account, do so (it's free). You can either use username and password or log in with a social provider (such as Facebook, Google, or Apple).
DATABASE_URL='postgres://exampleuser:123@localhost:5432/example'
AUTH0_CLIENT_ID =
AUTH0_CLIENT_SECRET =
AUTH0_DOMAIN =
AUTH0_BASE_URL = http://localhost:3000/
NEXTAUTH_URL = http://localhost:3000/
DATABASE_USER =
DATABASE_PASSWORD =
DATABASE_NAME =
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.