https://github.com/venkatr21/ghub-profile-api
https://github.com/venkatr21/ghub-profile-api
expressjs mongodb-atlas mongoose nodejs rest-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/venkatr21/ghub-profile-api
- Owner: venkatr21
- Created: 2020-11-21T04:09:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-24T08:53:14.000Z (over 5 years ago)
- Last Synced: 2025-02-28T22:12:07.659Z (over 1 year ago)
- Topics: expressjs, mongodb-atlas, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 8.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ghub profile api
---
---
### Table of Contents
- [ Introduction ](#Introduction)
- [ Installation](#Installation)
- [ Documentation](#Documentation)
- [ Contributors](#Contributors)
---
## Introduction
Github profile api is an express.js powered API backend service, which maintains track of user profile view count and responds a JSON object which can be rendered to their profile. Provides a seamless workflow, to maintain user records. Created by Me as a part of learning Express.js
**Features**
✅ Restful API based
✅ Faster Response time
✅ Lightweight and easily deployable
✅ Uses MongoDB for the database service
✅ Seamless workflow
---
## Installation
**Cloning repository and installing packages**
```bash
git clone https://github.com/venkatr21/ghub-profile-api
npm install
```
**Running the service(locally)**
```bash
touch .env // store your database credentials here
nodemon index.js
```
**Deploying the service**
```bash
create docker environment or deploy as a web app
```
---
## Documentation
- Provides RESTful routes to check the user profile in database and render the profile views.
- adding or updating profile in the database follows the route
```bash
host/user/add/
```
- rendering the json object with profile count follows the route
```bash
host/user/fetch/
```
---
## Contributors
---