sulphitic786 / contacts-keep Goto Github PK

This application was created using the MERN stack. React serves as the front end, Express serves as the backend, Node serves as the environment, MongoDB serves as the database, and mongoose serves as the ORM. I'm using the context API for the State manager.

(back to top)

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React.js
• Mongoose
• MongoDB
• Express

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/hansandika/Contact-Keeper.git

2. Install NPM packages

   npm install

3. Enter your API in config/default.json

   {
   	"mongoURI": "yourmongourl",
   	"jwtSecret": "yoursecretkey"
   }

4. Run Application

   npm run dev

(back to top)

Hans Geovani Andika - [email protected] - hansandika

Project Link: https://github.com/hansandika/Contact-Keeper

(back to top)