upleveled / next-js-example-spring-2022-atvie

Next.js Example - Spring 2022

• Next.js
• Postgres.js
• Jest
• Playwright
• GitHub Actions

Database Setup

Copy the .env.example file to a new file called .env (ignored from Git) and fill in the necessary information.

Follow the instructions from the PostgreSQL step in UpLeveled's System Setup Instructions.

Then, connect to the built-in postgres database as administrator in order to create the database:

Windows

If it asks for a password, use postgres.

psql -U postgres

macOS

psql postgres

Linux

sudo -u postgres psql

Once you have connected, run the following to create the database:

CREATE DATABASE <database name>;
CREATE USER <user name> WITH ENCRYPTED PASSWORD '<user password>';
GRANT ALL PRIVILEGES ON DATABASE <database name> TO <user name>;

Quit psql using the following command:

\q

On Linux, you will also need to create a Linux system user with a name matching the user name you used in the database. It will prompt you to create a password for the user - choose the same password as for the database above.

sudo adduser <user name>

Once you're ready to use the new user, reconnect using the following command.

Windows and macOS:

psql -U <user name> <database name>

Linux:

sudo -u <user name> psql -U <user name> <database name>

Running the migrations

To set up the structure and the content of the database, run the migrations using Ley:

yarn migrate up

To reverse the last single migration, run:

yarn migrate down

API Design

Base URL (development): http://localhost:3000/api/

1. Reading all users: GET /animals ➡️ api/animals/index.js
2. Reading a single user: GET /animals/:id ➡️ api/animals/[animalId].js
3. Creating a new user: POST /animals ➡️ api/animals/index.js
4. Deleting a user: DELETE /animals/:id ➡️ api/animals/[animalId].js
5. Updating a user: PUT /animals/:id ➡️ api/animals/[animalId].js