https://github.com/radhakishan404/crib-api

https://github.com/radhakishan404/crib-api

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/radhakishan404/crib-api
• Owner: radhakishan404
• Created: 2022-11-04T11:07:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-04T11:07:24.000Z (over 2 years ago)
• Last Synced: 2025-02-12T09:53:11.734Z (3 months ago)
• Language: JavaScript
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Crib Management Application API

 - This application is an Crib Management Application which allows users to create crib, see list of cribs, update cribs and delete cribs.

 - Its built using NodeJS and MongoDB based stack.

# How to setup

- You require these tools installed beforehand:

    - MongoDB Compass https://www.mongodb.com/products/compass

    - NodeJS https://nodejs.org/en/download/

- Clone the repo:

    - https://github.com/radhakishan404/crib-api.git

- After having these tools installed and working correctly, the setup has 2 phases

    - Database

        - Database collection will be created automatically once you connect with MongoDB.

    - Application:

        - To start the server, run these commands:

            - `npm install`

            - `npm run dev`

        - After that your server will be host on : `localhost:4000`.