Code Monkey home page Code Monkey logo

phone-book's Introduction

Phone Book - Built in Node.js

Description

This project enables you to achieve CRUD operations on a phone book

Environment Variables

You should create a .env files to customize the environment variables for the web api.
For the production, a file named .env needs to be created.
For the development, a file named .env.dev needs to be created.
For the tests, a file named .env.test needs to be created.
Sample environment file is below:

PORT=3000
NODE_ENV=development
MONGODB_URI=mongodb://localhost:27017/phone-book

How to start?

  1. Install npm modules by runnning: npm install in the root folder.
  2. Start the MongoDB server, and set MONGODB_URI in environment variables.
  3. Run the server according to the environment.
  • Production: npm run start
  • Development: npm run start:dev

You can also start the server using docker-compose. In the root folder, run the following command to start the web service:

docker-compose up -d

The server will listen port 3000.

Endpoints

  • Get all contacts /api/contacts (GET)
  • Create a new contact /api/contacts (POST)
  • Get a contact by id /api/contacts/:contactId (GET)
  • Update a contact by id /api/contacts/:contactId (PUT)
  • Delete a contact by id /api/contacts/:contactId (DELETE)

You can find the sample requests in the Postman collection placed in the root folder of the project.

How to run tests?

You can run npm test command to start testing.
Do not forget to create .env.test file for tests to run properly.

phone-book's People

Contributors

canercanbaz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.