Contacts API

Contacts API is an API that allows you to create, update, and delete contacts.

This projects is hosted on: https://contacts-api-nrestrepo05.herokuapp.com/contacts

Technologies

This project was made with Node.JS, Express.JS, and Mongo DB.

How to run it?

If you want to run it, yo need to create a Mongo DB wherever you prefer. I recommend Mongo Atlas.

If you already created your DB just follow the steps below:

1. Install dependencies

   npm i

2. create your .env file. The .env file must contain this:

   CONTACTS_DB_USER=XXXXXXXXXXXXXX
   CONTACTS_DB_PASSWORD=XXXXXXXXXXXXX
   CONTACTS_DB_PORT=XXXX

3. Now just run it with:

   npm run nodemon

Now it is running!

Contributing to Contacts API

To contribute to Contacts API, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the following people who have contributed to this project:

• @Nrestrepo05

Contact

If you want to contact me you can reach me at [email protected].

License

This project uses the following license: MIT.