This is the backend application for Phonebook App, a website for creating, editing and deleting contact data.
- Node.js
- express
- mongoose
- swagger-ui-express
- bcrypt
- dotenv
- @sendgrid/mail
- cors
- cors-env
- jimp
- joi
- jsonwebtoken
- morgan
- multer
- gravatar
- nanoid
- yamljs
- nodemon
-
Clone the repository from GitHub:
git clone https://github.com/Maryna-Korbet/phonebook-backend
-
Navigate to the project directory:
cd phonebook-backend
-
Install the dependencies:
yarn
-
Configure environment variables by creating a .env file in the root of the project and providing the necessary values. Refer to the .env.example file for the required variables.
-
Start the development server:
yarn start:dev
-
This will start the backend server on the specified port (default is 5000) and establish a connection to the MongoDB database.
-
Access the backend APIs using the base URL
http://localhost:5000
(or the specified port).
Documentation is available at http://localhost:5000/api/docs/
If you have any questions or suggestions, please feel free to reach out to me through one of the following channels:
- Email: korbet.maryna.developer@gmail.com
- LinkedIn: Maryna Korbet
I am always happy to connect and chat!