/be-readily

Primary LanguageJavaScript

Readily API

What is this Project?

This back-end project was developed whilst studying software development at Northcoders. It is an API used to programmatically access article data. Technologies used include Express, Postgres, SQL and TDD in Jest and Supertest.

I hosted the site using Supabase and Render, feel free to have a look! 🐸

Check out the front-end App and repo.


How can I play around with my own version of the repo?

Clone the repo

git clone https://github.com/andothergames/be-readily.git

Install dependencies

npm i

Create .env files in the root folder

echo PGDATABASE=nc_news > .env.development

echo PGDATABASE=nc_news_test > .env.test

Set up and seed databases

npm run setup-dbs

npm run seed


Testing

For testing using Jest:

npm run test


Versions

This project was built with: Node.js: v.21.7.0 Postgres: v14.11


This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders