Welcome to the Project setup and running guide! This README file will provide step-by-step instructions on how to set up and run the Project with npm. Make sure you follow all the steps to ensure a smooth process. Attention due to the client's request, I did not apply any design architecture pattern.
Before you begin, make sure you have the following installed on your system:
-
Node.js and npm: Make sure you have Node.js (since it includes npm) installed. You can download the latest version from https://nodejs.org/.
-
Postgres: Make sure you have postgres installed on your machine and know the password
Follow these steps to set up the required environment:
-
Clone this repository to your local system or download the files.
-
Navigate to the repository root directory using the terminal.
-
Run the following command to install the project dependencies:
- npm install
- Now you need to configure the postgres db connection
Make sure postgres is installed on your pc.
- navigate to the DB folder and continue clicking on the dbconexao.js file: where there is password: 'ENTER THE PASSWORD OF postgres', port: 5432, // default PostgreSQL port
Now that the environment is set up, you can start:
- In the terminal, still in the root directory of the repository, run the following command to start the project:
- npm run start
This will start on the default port (usually port 3000).
- Once the project is running, you can access the endpoints using the tools of your choice, such as browsers Click here to test or
curl.
To end the execution, go back to the terminal where you started and press Ctrl + C.
Remember, this is a basic guide to setting up and running your project using npm.
Have fun exploring the project! If you have any questions or encounter any problems, do not hesitate to consult the project installation documentation.