quinnter / be_nc_news

Backend for NC News project using PostgreSQL, KnexJs, and ExpressJs

nc_news

This is my API for my NC News project that I completed at Northcoders during the backend block. This is a database that stores articles, topics, comments, and users.

The project is hosted on Heroku and can be visited here where all the endpoints and example responses can be seen.

---

Built With

PSQL

KnexJs

Express

Node

npm

Mocha

Chai

---

Getting Started

To get a copy of the project up and running on your machine to test, follow these instructions.

Make sure you have Git and Node.js installed on your machine, then clone this repository

git clone https://github.com/quinnter/nc_news.git

Navigate to the correct directory and install node dependencies

npm i

Run the "setup:dbs" script

```bash
npm run setup:dbs

Run the "seed:run" script

npm run seed:run

Run a local version

npm run start

Then use an API testing tool like Insomnia to test the different API endpoints locally.

When you are done using the server use ctrl + c

To run test use the script

npm test

---

Available Routes and Methods

GET /api/topics
POST /api/topics

GET /api/articles
POST /api/articles


GET /api/articles/:article_id
PATCH /api/articles/:article_id
DELTE /api/articles/:article_id

GET /api/articles/:article_id/comments
POST /api/articles/:article_id/comments

PATCH /api/comments/:comment_id
DELETE /api/comments/:comment_id

GET /api/users
POST /api/users

GET /api/users/:username

---