Next TypeScript Prisma PostgreSQL Project

This project is to demonstrate how to setup a project using Next.js with TypeScript as a web application with Prisma as the ORM using PostgreSQL v15 as the data source as a Full Stack Web App.

Prerequisites

The following services are require for development:

• GIT
• nvm
• Docker

Project Setup

Dependencies

1. Fork the project and clone your GitHub project

   git clone https://github.com/${USER_NAME}/quick-id-verification

2. Install node and npm version of the project

   nvm use
   npm install -g npm@${NPM_VERSION}

3. Install project dependencies

   npm ci

4. Copy .env

   cp .env-local .env

Start Database

1. Start the database using Docker

   npm run docker

2. Import migration to Database

    npm run prisma:deploy

The command will import the migrations created to the database.

Start the Next app

1. Start the Next app

   npm run dev

The app will be running on the port 3000 and accessible in http://localhost:3000

Test

To run tests is required to have the web app running.

1. Run unit and E2E tests

   npm run test

2. Run coverage check

   npm run test:coverage:check

Development with Codespaces

The app has a predefined Codespaces configuration available at .devcontainer/devcontainer.json as this web app has been developed using Codespaces.

Follow this guide on how to get started with Codespaces.

Acknowledgment

The project has been inspired on a Prisma example.

License

This project is licensed under the MIT License. See the LICENSE file.