ADDRESSBOOK API

A REST API written in nodeJS that allows a user to Create, Read, Edit and Delete Users and Addresses

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

1. Node JS
2. Mongo DB

Installing

A step by step series of examples that tell you how to get a development env running

1. Create a .env file with a MONGO_URI and API_VERSION variables.
2. Run npm install or Yarn to install all the required node packages
3. To run in dev mode use npm run dev or yarn dev
4. To run eslint run npm run lint or yarn lint
5. To run it in production mode use npm run start or yarn start

You should see a console message with Server is running on port 3000

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc