This project serves relational data from a generic news platform in various formats. The app is written in JavaScript (Node.js), using the Express.js framework and the data is hosted in a PostgreSQL database. It's features full integration testing for every endpoint and robust error-handling for every requests.
A functional demo of the project can be found here hosted by Render and using Supabase to host the Postres database
Please note all endpoints start with /api
To install and run this project locally:
- Clone down the repo.
- Run
npm i. - Create a .env.test and .env.development file in the project's root directory to store database environment variables.
- In each of the new files you've created, add the
PGDATABASEenvironment variable at set the value to eithernc_news_testfor the test file ornc_newfor the development file. - Run
npm run setup-dbsto initialise the test and development databases. - Run
npm run seedto populate the databse with all the tables and their data. - The server can then be started with
npm run start.
This project is verified to work with Node.js v22.9.0+, npm v10.8.3+, and PostgreSQL v14.12+
This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders