NC NEWS API

https://back-end-news-project.onrender.com/api

 

🚩 Table of Contents

• NC NEWS API
  • 🚩 Table of Contents
  • 📑 About the project
    • Key features
  • 🛠️ Set up
    • Clone the repo
    • Install dependencies
    • Create 2 .env files
    • Create local db
    • Seed the local db
    • Start your local server
    • Run tests
    • Check its up and running
  • 🔬 Testing
  • 📍 Minimum requirement

 

📑 About the project

This is a project which was created for the Northcoders backend project. The goal of this project is to provide a way to interact with data expected on a news site, such as topics, articles and comments.

Key features

• Able to retrieve articles with queries
• Able to create comments for articles
• Able to update votes on comments
• Able to delete comments

 

🛠️ Set up

Clone the repo

$ git clone https://github.com/NicollahSekete/be-nc-news.git

Install dependencies

$ npm install

Create 2 .env files

• Create a .env.test and a .env.development file
• in both file add PGDATABASE=<database_name_here> with the correct database name for the environment (see /db/setup.sql for the database names)

Create local db

$ npm run setup-dbs

Seed the local db

$ npm run seed

Start your local server

$ npm start

Run tests

$ npm test

Check its up and running

In a browser or with Insonia look up:

http://localhost:9090/api/articles/1

🔬 Testing

You are able to run current tests or tests you create through the predefined test script available.

📍 Minimum requirement

• Node version >= 16.0.0
• PostgreSQL version >= 14.6