Northcoders News API

Welcome to Northcoders News API containing articles on a variety of topics, users can interact with votes and comments.

About The Project

Hosted REST API server available at - https://nc-news-z2fk.onrender.com/api/

---

Built With

• Javascript
• PQSL
• HTTP/Express Server Creation
• Full Test Driven Development
• Supertest & Jest for Full Integration Testing

Getting Started

In order to set up a local copy, please follow these simple steps.

Repo

Repo can be found here:- https://github.com/AvrilHunter/NC-News

Installation and Set Up

1. Clone the repo

   git clone https://github.com/AvrilHunter/NC-News

2. Install NPM packages

   npm install

3. Create two files: .env.test, .env.development and .env.production

4. Update these files:-

    PGDATABASE="insert database name / url link here" 

5. Database names and URL can be requested via email from avrilhunter15@gmail.com

6. Seed your local database through running the command

   seed-prod

7. Tests can be run using the command

   npm run test

System Requirements

Node minimum version = 10.5.2 Postgres minimum version = 14.11

Usage

The project is a REST API with various news articles.

• Like something - you can add a vote to the article.

• Disagree with an article - you can remove votes from the article.

• Have an opinion - feel free to post a comment.

• Join the conversation now!