https://github.com/kamiviolet/my-nc-news
Backend project, with application of Kanban and Git branches, etc.
https://github.com/kamiviolet/my-nc-news
api-rest javascript mvc postgresql
Last synced: 9 days ago
JSON representation
Backend project, with application of Kanban and Git branches, etc.
- Host: GitHub
- URL: https://github.com/kamiviolet/my-nc-news
- Owner: kamiviolet
- Created: 2023-05-09T09:49:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T19:46:51.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T16:19:16.001Z (2 months ago)
- Topics: api-rest, javascript, mvc, postgresql
- Language: JavaScript
- Homepage: https://nc-news-au6b.onrender.com
- Size: 622 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Northcoders News API
## Purpose
This API mimics the building of back-end service for the purpose of accessing application data programmatically so as to provide information to the front-end architecture.
## Toolkit
This API is built in Node.JS environment, using PostgreSQL as database and node-postgres as connection, tested with Jest.
MVC architectural pattern is implemented.
## Set up environment
For security, the environment files are not included in this repository. In order to run this API, please follow the instructions as below:
1. run `npm-install`
2. create '.env.test' and '.env.development' on the root directory.
3. update the aforesaid env files with reference of '.env.example'.
4. the database_name can be found inside ./db/setup.sql.
## List of available endpoints for the API
To get the list of available endpoints, please use GET to /api. The response will ccontain the following information:
1. description of the endpoint
2. acceptable query options
3. format of request body for POST/PUT/PATCH
4. examples of responses