DEPRECATION NOTICE

This template is no longer up to date. For an updated template, either as a team or individually, we encourage you to explore our latest template produced by INTDEV. Thank you for your interest in our work!

next-postgres

January 4th, 2022 ➝ I recommend you use www-react-postgres instead because it does not have an express server or a need for babel, therefore the template has less dependencies. That means there will be less attention cost required.

This setup is using:

• NextJS 12.0.7
• Postgres 11
• Express 4.17.2
• Emotion CSS-in-JS 11.7.1
• GoogleAPIs 92.0.0
• Knex 0.95.15

It is for:

• Running a website with users.
• Using Google web browser OAuth.
• Replacing my old work with next-postgres-sequelize.
• Deploying with https://render.com or something like it.

Setup

Step 1

Clone this repository!

Step 2

Create an .env file at your project root.

CLIENT_ID=GET_ME_FROM_GOOGLE
CLIENT_SECRET=GET_ME_FROM_GOOGLE
JWT_SECRET=74b8b454-29a6-4282-bdec-7e2895c835eb
PASSWORD_SECRET=\$2b\$10\$oaBusYfHLawNiFDqsqkTM.

• Generate your own PASSWORD_SECRET with BCrypt.genSaltSync(10). You need to escape $ signs.
• Generate your own JWT_SECRET.
• Obtain CLIENT_ID and CLIENT_SECRET from https://console.developers.google.com after you setup your application.
• Use CMD+F to find REDIRECT_URIS in ~/common/credentials. Google needs this string for the Authorized redirect URIs setting. The default is: http://localhost:1337/sign-in-confirm.

Step 3

This is important. Enable People API. Otherwise Google Auth will not work.

Setup: Running the website (OSX)

All steps assume you have Homebrew installed on your machine. You might want to install iTerm since you need multiple terminal windows open as well.

Using another version of Postgres? That may be okay. I use Postgres 11 to share versions with Render but I have tried these steps with Postgres 9 as well.

Installing Postgres 11

Mileage may vary with a different version.

brew uninstall postgresql
brew install postgresql@11
brew link postgresql@11 --force

Installing Node

Make sure NodeJS version 10+ is installed on your machine.

brew install node

Installing nodemon

We use nodemon to reload the site whenever changes are made locally.

npm install -g nodemon

Installing Node packages

Once you have Postgres and Node, run these commands:

npm install
npm run dev

Run Postgres

In a seperate terminal tab run your postgres version, in this case the command below is referencing Postgres 11.

postgres -D /usr/local/var/postgresql@11 -p 1334

You may need to run brew services stop postgresql@11 since we're running postgres on a different port.

If you get an error that lock file "postmaster.pid already exists like I did, you can delete that file with something like rm /usr/local/var/postgresql@11/postmaster.pid.

Create a new database

• Start with creating an admin user.
• Finish with creating a database for testing.

# Enter Postgres console
psql postgres -p 1334

# Create a new user for yourself
CREATE ROLE admin WITH LOGIN PASSWORD 'oblivion';

# Allow yourself to create databases
ALTER ROLE admin CREATEDB;

# You need to do this to install uuid-ossp in a later step
ALTER USER admin WITH SUPERUSER;

# Exit Postgres console
\q

# Log in as your new user.
psql postgres -p 1334 -U admin

# Create a database named: nptdb.
# If you change this, update knexfile.js
CREATE DATABASE nptdb;

# Give your self privileges
GRANT ALL PRIVILEGES ON DATABASE nptdb TO admin;

# List all of your databases
\list

# Connect to your newly created DB as a test
\connect nptdb

# Exit Postgres console
\q

Setup: Fill database with tables

Run the following commands:

npm run do-setup-database
npm run do-seed-database

View the website

View http://localhost:1337 in your browser.

Scripts

If you need to run node script without running the server, use this example to get started

npm run script example

Setup: Production deploy

Coming soon.

Questions?

Feel free to slang any feels to @wwwjim.