This is a Node.js project that allows users to save contact information.
SignupLoginCreate a new contactRetrieve a list of your contactsRetrieve a single contactUpdate a contactDelete a contact
JavascriptNodeJsPostgreSQLnpmJWTjestGmail smtpPostman
Node.jsnpmPostgreSQL DatabasePort 3000 open and free
To use this project, you will need to have Node.js and NPM installed. Once you have installed Node.js and NPM, you can clone this repository and install the dependencies with the following commands:
git clone https://github.com/RevEmmanuel/hux-assessment-backend.git
cd hux-assessment-backend
npm install
- Install Node.js
To start the project, run the following command:
npm start
The project has a REST API that can be accessed at the following URL:
http://localhost:3000/
The API has the following endpoints:
POST /auth/signup POST /auth/login GET /auth/verify/:otp POST /contacts/create GET /contacts/all GET /contacts/:id PUT /contacts/update/:id DELETE /contacts/delete/:id
The project can be configured using a .env file. The .env file should contain the following environment variables:
PORT=3000
DB_USER=
DB_NAME=
DB_PASSWORD=
DB_HOST=
DB_PORT=
JWT_SECRET=
EMAIL_USERNAME=
EMAIL_PASSWORD=
EXTERNAL_URL=To run the tests for the project, run the following command:
npm test
To deploy the project to production, you can use a service such as Heroku or AWS Elastic Beanstalk or Railway. This project is currently hosted on railway.
Postman Documentation Deployed Website URL Frontend GitHub Repository
Adeola Adekunle
- GitHub (RevEmmanuel)
- Twitter (@Adeola_Ade1)
- Instagram (@deolaaxo)
- LinkedIn (Adeola Adekunle)
- Email(Adeola Adekunle)
If you would like to contribute to this project, please feel free to fork the repository and submit a pull request.
This project is licensed under the MIT license