Welcome to the Node.js project setup guide. This document will guide you through the steps to set up and run the project on your local machine. This project utilizes PostgreSQL as its database and is deployed on an AWS EC2 instance.
Before you start, make sure you have the following tools installed on your system:
- Node.js
- Git
- PostgreSQL
- npm (Node Package Manager)
Follow these steps to get the project up and running on your local machine:
Clone the project repository to your local machine using the following command:
git clone https://github.com/Ghost1997/smartlead.git
Navigate to the project directory and create a .env
file. You can use the provided example.env
file as a template. Fill in the appropriate values for the environment variables, such as database connection settings and any other configuration variables required by the project.
cp example.env .env
Edit the .env
file and provide the necessary values.
Install the project dependencies using npm by running the following command in the project directory:
npm install
To start the server in development mode, run the following command:
npm run dev
This command will start the Node.js server locally. You should see console logs indicating that the server is up and running.
Once the server is running, you can access the health check endpoint using the provided URL:
http://localhost:3000/healthcheck
This URL will provide you with information about the health status of the deployed application.
Please note that the project is deployed on an AWS EC2 instance. The health check URL mentioned is where the deployed application's health status can be monitored.
http://13.53.174.158:4000/healthcheck
Congratulations! You have successfully set up the Node.js project on your local machine and learned how to run the server. If you encounter any issues or have questions, feel free to reach out to the project maintainers.
Provided Postman collection for sample request in Project folder import postman collection to see All API request
Happy coding! 🚀