https://github.com/rijalghodi/x-press-publishing

Internal tool for a comic book publishing company called XPress Publishing
https://github.com/rijalghodi/x-press-publishing

back-end-development expressjs nodejs sqlite3

Last synced: 3 months ago
JSON representation

Internal tool for a comic book publishing company called XPress Publishing

• Host: GitHub
• URL: https://github.com/rijalghodi/x-press-publishing
• Owner: rijalghodi
• Created: 2022-11-05T09:47:53.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-05T10:11:22.000Z (over 3 years ago)
• Last Synced: 2025-01-22T03:08:25.151Z (over 1 year ago)
• Topics: back-end-development, expressjs, nodejs, sqlite3
• Language: JavaScript
• Homepage:
• Size: 672 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# XPress Publishing

## Project Overview

In this capstone project, I created an internal tool for a comic book publishing company called XPress Publishing.

The XPress Publishing internal tool should allow users to:

- Create, view, and update artists

- Create, view, update, and delete comic book series

- Create, view, update, and delete issues of a specific comic book series

You can view all of this functionality in action in the video below:

## How To Begin

- Download the code for this project. After downloading the zip folder, double click it to uncompress it and access the contents of this project.

- Install all the modules needed by this project by running `npm install` in the project root

- Open the `index.html`

- Run the server by `node server.js` in the project root

## Testing

A testing suite has been provided, checking for all essential functionality and edge cases.

To run these tests, first, open the root project directory in your terminal. Then run `npm install` to install all necessary testing dependencies (if you haven't already). Finally, run `npm test`. You will see a list of tests that ran with information about whether or not each test passed. After this list, you will see more specific output about why each failing test failed.

### Database Table Properties

- **Artist**

  - id - Integer, primary key, required

  - name - Text, required

  - date_of_birth - Text, required

  - biography - Text, required

  - is_currently_employed - Integer, defaults to `1`

- **Series**

  - id - Integer, primary key, required

  - name - Text, required

  - description - Text, required

- **Issue**

  - id - Integer, primary key, required

  - name - Text, required

  - issue_number - Text, required

  - publication_date - Text, required

  - artist_id - Integer, foreign key, required

  - series_id - Integer, foreign key, required

### Route Paths and Functionality

**/api/artists**

- GET

  - Returns a 200 response containing all saved currently-employed artists (`is_currently_employed` is equal to `1`) on the `artists` property of the response body

- POST

  - Creates a new artist with the information from the `artist` property of the request body and saves it to the database. Returns a 201 response with the newly-created artist on the `artist` property of the response body

  - If any required fields are missing, returns a 400 response

**/api/artists/:artistId**

- GET

  - Returns a 200 response containing the artist with the supplied artist ID on the `artist` property of the response body

  - If an artist with the supplied artist ID doesn't exist, returns a 404 response

- PUT

  - Updates the artist with the specified artist ID using the information from the `artist` property of the request body and saves it to the database. Returns a 200 response with the updated artist on the `artist` property of the response body

  - If any required fields are missing, returns a 400 response

  - If an artist with the supplied artist ID doesn't exist, returns a 404 response

- DELETE

  - Updates the artist with the specified artist ID to be unemployed (`is_currently_employed` equal to `0`). Returns a 200 response.

  - If an artist with the supplied artist ID doesn't exist, returns a 404 response

**/api/series**

- GET

  - Returns a 200 response containing all saved series on the `series` property of the response body

- POST

  - Creates a new series with the information from the `series` property of the request body and saves it to the database. Returns a 201 response with the newly-created series on the `series` property of the response body

  - If any required fields are missing, returns a 400 response

**/api/series/:seriesId**

- GET

  - Returns a 200 response containing the series with the supplied series ID on the `series` property of the response body

  - If a series with the supplied series ID doesn't exist, returns a 404 response

- PUT

  - Updates the series with the specified series ID using the information from the `series` property of the request body and saves it to the database. Returns a 200 response with the updated series on the `series` property of the response body

  - If any required fields are missing, returns a 400 response

  - If a series with the supplied series ID doesn't exist, returns a 404 response

- DELETE

  - Deletes the series with the supplied series ID from the database if that series has no related issues. Returns a 204 response.

  - If the series with the supplied series ID has related issues, returns a 400 response.

  - If a series with the supplied series ID doesn't exist, returns a 404 response

**/api/series/:seriesId/issues**

- GET

  - Returns a 200 response containing all saved issues related to the series with the supplied series ID on the `issues` property of the response body

  - If a series with the supplied series ID doesn't exist, returns a 404 response

- POST

  - Creates a new issue, related to the series with the supplied series ID, with the information from the `issue` property of the request body and saves it to the database. Returns a 201 response with the newly-created issue on the `issue` property of the response body

  - If any required fields are missing or an artist with the supplied artist ID doesn't exist, returns a 400 response

  - If a series with the supplied series ID doesn't exist, returns a 404 response

**/api/series/:seriesId/issues/:issueId**

- PUT

  - Updates the issue with the specified issue ID using the information from the `issue` property of the request body and saves it to the database. Returns a 200 response with the updated issue on the `issue` property of the response body

  - If any required fields are missing, returns a 400 response

  - If a series with the supplied series ID doesn't exist, returns a 404 response

  - If an issue with the supplied issue ID doesn't exist, returns a 404 response

- DELETE

  - Deletes the issue with the supplied issue ID from the database. Returns a 204 response.

  - If a series with the supplied series ID doesn't exist, returns a 404 response

  - If an issue with the supplied issue ID doesn't exist, returns a 404 response