Development environment for the FamilyApp. Composed of an API service in Node TS, and a PostgreSQL database, both containerized in Docker.
Designed to facilitate development tasks.
Docker daemon is required to start the development server. Can download from the official web:
Package manager
Node engine is a JavaScript runtime built on Chrome's V8 JavaScript engine. That allows to execute Javascript in our machines. We can install it through NVM (Node Version Manager), and so we need to install it first. Here is a FreeCodeCamp tutorial, very easy.
You need a version of node 12 or higher. I recomend to use Node 16.20.0 (LTS).
Clone the current repository on your development machine.
Only is necesary to install the first time. The next time we want to use the server, it will only be necessary to execute the commands described in the Usage section.
In the main folder of the project:
Start a terminal and run the following command
yarn run server:create This will create the docker containers where our server will be running. It spend aroung 30 - 40 second on create it. Then you will see a message that says Done in 00.00s
Use the following command to init the server.
yarn run startUse the command below to stop the server, when you finish to use it.
yarn run stopYou can test the app is running, navigate to localhost:3000 in your browser. You need to see the following message:
{"status":"success","message":"STATUS: OK!"}
Work in progress...