typescript-supergraphql

This README provides a guide for setting up and running the project.

Prerequisities

Node.js v18.17.0
NVM
Docker

Step-by-Step Setup Guide

• Step 1: Install Node.js v18.17.0

Before you can run this project, you need to ake sure that Node.js v18.17.0 is installed on your computer. To install Node.js, you can download it form the official Node.js website

Alternatively, you can use a version manager like nvm to install Node.js. Here's how you would install Node.js v14.x using nvm:

nvm install 18.17.0
nvm use 18.17.0

• Step 2: Install Docker

Docker is required to create and manage the containers in which the project runs. You can download Docker from the official Docker website.

Step 3: Install Project Dependencies

Once Node.js and Docker are installed, navigate to the project directory and run the following command to install the project dependencies:

npm i

• Step 4: Start Docker Containers

Now, you can use the provided npm script to start the Docker containers necessary for the project:

npm run start:stack

This command will build and start the Docker containers. Make sure Docker is running before executing this command.

• Step 5: Start the Application

You can start the application by running:

npm start

• Step 6: Test the Application

Finally, you can test the application by running:

npm test

This command will start the Node.js application. You should now be able to access the application through your web browser.

Congratulations!

You have successfully set up and started the application. If you encounter any issues or have any questions, please refer to github issue site

CONTRIBUTOR

OTHERS