About

This is a CRUD Duties Web App built with Next.js and GraphQL powered with PostgreSQL database with Ant Design component library for the web UI

Prerequisite

1. Install git according to your operating system and clone this project. In Windows, make sure Git BASH is installed properly (see guide) to be able to run .sh script later.
2. Install Node.js with PNPM
3. Install Docker and docker-compose. Make sure the current user can run docker and docker-compose from command line without using sudo.

Getting Started

Install all the node package dependencies by running:

pnpm install

For developing, run the PostgreSQL docker container and the development server:

docker-compose up -d db
pnpm run dev

This project is using Jest to do the unit test; to check the test coverage run the following command:

pnpm run test:coverage

For deployment, in MacOS and Linux, cd to the project root from your terminal and run the following command:

sh run.sh

in Windows, open Git BASH (from prerequisite#1) by right-clicking on the project folder and selecting the Git Bash Here option from the context menu (right-click menu) before running the following command in the Git BASH:

sh run.sh

Open http://localhost:3000 with your browser to see the result.