Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 2.26 KB

README.md

File metadata and controls

86 lines (63 loc) · 2.26 KB
Raw

Manga API

A Node.js application for managing manga data with create, read, update and delete functionality. It has 100% test coverage and uses a docker postgres image to run tests in isolation. This service is deployed and can be accessed here: Manga API

Requirements

Node version 20.5.1
Elephant SQL
Docker Desktop (Required for testing only)

Installation & Setup:

Fork & clone the repo then install dependencies:

git clone https://github.com/<github username>/Manga-API.git
cd Manga-API/server
npm install

Create a .env file with the following variables:

touch server/.env
PORT=<your port>
DB_URL=<your elephant sql database url>

To setup your database run:

cd server
npm run seed-db

To run project type command:

cd server
npm run dev

You can now visit the endpoints in a browser. To test create, update and delete you can run the testEndpoints.sh script by adding your BASE_URL or by using an api testing platform (postman, thunderclient...).

cd MANGA-API
./testEndpoints.sh

Run tests:

Run the setupTestDB.sh file. It will add a TEST_DB url to the .env file and run the docker Compose file. You may need to update the docker command from docker compose to docker-compose depending on your Docker cofiguration. Ensure that the Docker Daemon is running.

To run tests or view coverage the following commands are available:

cd server
npm run test
npm run unitTests
npm run integrationTests
npm run coverage

Technical Stack

  • Node.js: Runtime for JavaScript outside the browser, ideal for restful API's.
  • Express: Minimalist Node.js web framework used to run server.
  • Jest/supertest: Jest for JavaScript testing and Supertest for HTTP server testing.
  • Docker-compose: Used to containerise a postgres image on any device.
  • PostgreSQL: Open-source relational database known for reliability and advanced features. Used for test database.
  • Elephant-sql: Cloud-based PostgreSQL database for production database.

Endpoints:

GET /
GET /mangas
GET /mangas/:id
POST /mangas
PATCH /mangas/:id
DELETE /mangas/:id

Enjoy!