Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.25 KB

README.md

File metadata and controls

32 lines (23 loc) · 1.25 KB
Raw

🍃node-posts

Simple Node JS API. Live demo available here

Languages and technologies 🛠

  • Node JS
  • Express
  • MongoDB

Installation💾

Requirements

  1. Node JS
  2. Mongo DB Atlas account

Steps

  1. Run git clone https://github.com/JacobJax/node-posts.git
  2. Run cd node-posts to navigate to the project folder
  3. Run npm install to install dependencies

Running project ⚙

After cloning the project, installing node modules and creating a Mongo DB Atlas account, create a .env file. In the .env file, add your connection string from Mongo DB atlas which looks something like this mongodb+srv://<username>:<password>@cluster0.wwoebgl.mongodb.net/?retryWrites=true&w=majority.

Set DB_CONNECTION_STRING=mongodb+srv://<username>:<password>@cluster0.wwoebgl.mongodb.net/?retryWrites=true&w=majority and PORT=5000(Optional)

You can then run npm run start to view the project on localhost:5000.

Contributing 👷🏿‍♀️

  • Clone or Fork the project
  • Create an issue describing what you're working on and create a branch from your issue.
  • Work on your issue, push to the brach you created and create a new pull request.