https://github.com/chen-abudi/news-explorer-api
API for News Explorer
https://github.com/chen-abudi/news-explorer-api
Last synced: 8 months ago
JSON representation
API for News Explorer
- Host: GitHub
- URL: https://github.com/chen-abudi/news-explorer-api
- Owner: Chen-Abudi
- Created: 2022-10-22T14:27:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-28T15:12:10.000Z (over 2 years ago)
- Last Synced: 2024-12-30T20:27:44.786Z (10 months ago)
- Language: JavaScript
- Homepage: https://news-explorer-api-mu.vercel.app
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backend for Final Project at Practicum Program
# news-explorer-api 📰🌐🗺️
## Overview
- Intro
- Technologies & Techniques
- Routes
- Link to RESTful API
## Intro
This is the backend repo with custom RESTful API for News Explorer Service React App (**which is the final project at Practicum**).
The server is deployed on _GCP_ (Google Cloud Platform) virtual machine.
It was created with Express and MongoDB to create, store, read, update, and remove user and article data.
## 🛠️ Technologies & Techniques
- NodeJs
- Express.js / express-winston
- MongoDB
- Jsonwebtoken
- Celebrate / Joi
- Validator
- Postman for testing
- **_`Vercel` Deployment_**
- CI/CD
- `Vercel Serverless technology`
- REST API with CRUD Implementation
- Git/GitHub
## API Routes :
| RESTful API Enpoints | HTTP Methods | Usage Purpose |
| -------------------- | :----------: | -----------------------------: |
| /signup | POST | User Registration |
| /signin | POST | User Login |
| /users/me | GET | GETting user data |
| /articles | GET | GETting data from all articles |
| /articles | POST | Creating a new article |
| /articles/:\_id | DELETE | DELETE an article by its id |
## _The project is evolving, more details soon_
## [Link to RESTful API](https://news-explorer-api-mu.vercel.app/)