This project is a demonstration of my database skills from the Northcoders bootcamp. It's an API that lets you get news articles, comment on them, vote up or down.
Feel free to clone this repo and take a look at what's going on behind the scenes. I also have it hosted over at NC News API so you can see it live.
The database for this project was built with postgres, and uses it to test. If you don't already have it, install postgres and set up a new user
This project was built using node.js v22.11.0 and npm v10.5.1. If you don't already have them, you can find instructions to install them both here: Installing node.js and npm
To clone the repo onto your computer, you're also going to need a local version of git. See the git documentation.
Once you've got the pre-setup setup, it's time to clone the repo. In the command line, navigate to the folder you want to work from, and then run the following line:
git clone https://github.com/seanbuckle/nc-news.git
cd nc-newsNow you can open the folder in a code editor. I built this in VSCode.
The main dependencies you're going to need are:
- dotenv - handles the data environment variables
- Express - runs the server
- pg - handles the database setup
- pg-format - handles the SQL queries
npm i dotenv express pg pg-format*** TESTING ONLY ***
The other dependencies are for testing:
- husky - checks tests before commits
- jest - the testing suite
- jest-extended - extends functionality of jest
- jest-sorted - adds sorting features to jest
- supertest - used for integration testing
npm iCreate two file .env.development and .env.test
.env.development
PGDATABASE=[DATABASE_NAME]
.env.test
PGDATABASE=[DATABASE_NAME]_test