Skip to content
This repository has been archived by the owner on May 9, 2023. It is now read-only.

tomkotlar/nc-news_second

Repository files navigation

📰 Northcoders News API

The API is hosted on Heroku with following endpoints:

GET /api 

GET /api/topics   

GET /api/users/:username

GET /api/articles

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

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

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


To view the example of JSON data Please click on the rocket

🚀 /api
🚀 /api/topics
🚀 /api/users/:username
🚀 /api/articles
🚀 /api/articles/:article_id
🚀 /api/articles/:article_id/comments

📋 Instructions

On GitHub create your own public repository for your project. Make sure NOT to initialise it with a README or .gitignore.

git remote remove origin

# This will prevent you from pushing to the original repo.
git remote add origin <YOUR-GITHUB-URL>

# This will add your GitHub location to your local git repository.
# You can confirm this by checking the new git remote.

📂 Setting up your own repository

git clone https://github.com/tomkotlar/nc-news_second

cd be-nc-news

📀 Install

npm install

You will install dependencies: NodeJS | Cors | PostgreSQL | Knex | Express

📚 Setup databese

npm run setup-dbs

npm run seed

💻 Local Server

npm run start

📈 Running the test

npm test