https://github.com/onfranciis/hngx-stage2

HNGx Stage 2 Task
https://github.com/onfranciis/hngx-stage2

hngx mongodb nodejs typescript

Last synced: about 1 month ago
JSON representation

HNGx Stage 2 Task

• Host: GitHub
• URL: https://github.com/onfranciis/hngx-stage2
• Owner: onfranciis
• Created: 2023-09-10T19:34:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-13T21:46:12.000Z (over 1 year ago)
• Last Synced: 2023-09-14T12:35:17.266Z (over 1 year ago)
• Topics: hngx, mongodb, nodejs, typescript
• Language: TypeScript
• Homepage: https://hngx-stage2.onrender.com/
• Size: 189 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CRUD User

### Everything you need to know

By Francis Onukwu

---

![UML diagram for the CRUD User Program By Francis Onukwu](./src/utils/UML.png)

This is a backend project built using TypeScript for a NodeJS server and a MongoDb powered database. To get this running on your machine, you must first download and install [NodeJs](https://nodejs.org/en/download), clone this repository by running

`git clone https://github.com/onfranciis/hngx-stage2`, navigate to the `hngx-stage2` folder in your terminal and running `npm install`. Once all the dependencies have been installed you should create a `.env` file and fill it with these details

```

PORT = "1234"

DEV_DB_URL = 

ENVIRONMENT = "development"

```


You can get a free MongoDb Url from [Atlas](https://www.mongodb.com/atlas/database). Now in your terminal, run `npm run serve` and if successfull, you should see `... development server has started on port 1234`. Now head over to `http://localhost:1234` on your browser and if everything is successfull, you should see this

```

{

  connected:true

}

```




The API documentation can be found [here](./DOCUMENTATION.md)