Northcoders News API

Welcome to my backend project!

This is the RESTful API for Northcoders News, a Reddit-like application, developed using Node.js and PostgreSQL. The purpose of this project is to provide a platform where users can share articles, comment on them, and vote for their favourites.

The hosted version of this project can be found on https://nc-news-dkoj.onrender.com

• Database hosted on ElephantSQL
• API hosted on Render

Getting Started

To get started with this project, follow these instructions:

Prerequisites

Before running the server, make sure you have the following installed on your machine:

• Node.js v21.7.1
• Postgress server version 16.2

Installation

1. Clone the repository

   git clone <repository-url>

2. Navigate into the project directory:

   cd be-nc-news

3. Create two .env files:

   • .env.test
   • .env.development

4. Into each .env file, add PGDATABASE=, with the correct database name for that environment (see /db/setup.sql for the database names)

   • please ensure the .env files are .git.ignored

5. Install the dependencies

   npm install

6. Set-up database

   npm run setup-bds

   Test database

   This project uses jest as a testing framework. The test database is being re-seeded before each test. To run the test file use the following command:

   npm test

   Development database

   1. To seed the database run:

   npm run seed

   2. To start the server, run the following command:

   npm run start

   By default, the server will run on port 9090. You can access the API at http://localhost:9090/api

Endpoints

/api

• GET - Get all endpoints of the api

/api/topics

• GET - Get all topics

/api/articles

• GET - Get all articles. Accepts queries: "author", "topic", "sort_by", "order"
• POST - Inserts a new article

api/articles/:article_id

• GET - Get an article by ID
• PATCH - Updates the votes value of an article

/api/articles/:article_id/comments

• GET - Get all comments for an article.
• POST - Inserts a new comment to an article

/api/comments/:comment_id

• DELETE - Delete a comment
• PATCH - Updates the votes value of a comment

/api/users

• GET - Get all users

/api/users/:username

• GET - Get an user by username

For more detailed information about each endpoint, refer to the endpoints.json file

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

Acknowledgments

This project was developed as part of the Northcoders Software Development bootcamp curriculum.