xhelpers-websocket-sample

Check out the live examples:

• Todo Web WS (Backend)

Check out the front source

• Todo Web WS

Main Dependencies and Requisites

• x-helpers-api 2.1.6.
• TypeScript 3.8.
• Node.js 12+.
• Mongoose 5.7.
  • Mongodb.

Option 1 - With Docker

Before you Start

Install:

• docker-compose.
• docker.

Set the environment variables

Create a file named .env with them in the project root folder. Following the provided env.example.

For a fast start you can just rename the env.docker.example file to .env

Run the project

On the terminal:

docker-compose up

if you are using your own database, run the following command to start just the application

docker-compose up api

Go to http://localhost:3000/documentation

To stop just run

docker-compose down

Option 2 - Without docker

Before you Start

Install:

• docker-compose.
• docker.
• Node.js 12+.
• NPM.

Set the environment variables

Set the environment variables on your context or create a file named .env with them in the project root folder. Following the provided env.example.

For a fast start you can just rename the env.example file to .env

Start the database

Run:

docker-compose up -d db

Run the project

Install the dependencies:

npm install

npm run dev

Go to http://localhost:3000/documentation

To stop the database just run

docker-compose down