This server is hosted at: https://oer-bookr.herokuapp.com
- Deployed front-end
- Log in as an demo user with email
admin& passwordadmin1234
- Log in as an demo user with email
- axios: ^0.19.0
- bcryptjs: ^2.4.3
- cors: ^2.8.5
- express: ^4.17.1
- helmet: ^3.20.0
- jsonwebtoken: ^8.5.1
- knex: ^0.19.2
- knex-cleaner: ^1.3.0
- pg: ^7.12.1
- sqlite3: ^4.1.0
- devDependencies
- cross-env: ^5.2.0
- jest: ^24.9.0
- nodemon: ^1.19.1
- supertest: ^4.0.2
- Node.js - JavaScript runtime for executing JavaScript at the server outside the browser
- Express.js - Lightweight web framework to bootstrap Node.js APIs
- SQLite - Super lightweight database to bootstrap development environments
- PostgreSQL - An advanced object-relational database for production environments
- Knex.js - A SQL query builder that helps abstracting migrations and DDLs for different database types into a single coherent structure
- Bcrypt.js - A module to help make passwords more secure
- CORS - A Node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.
- Helmet - A collection of 14 smaller middleware functions that set HTTP response headers.
- JWT - JSON Web Token for authorization and client side tokens for security
- Supertest - A test module for HTTP assertions
- Jest - A simple JavaScript testing framework
-
Method Endpoint Requires Returns Description POST /login username, password message: 'You are logged in', token, user_id Used to login POST /register name, username, password 201 Used to register Method Endpoint Requires Returns Description GET / nothing Array of all books Used to get all books GET /:id id Single book Get a single book POST / title, publisher, license, authors New book Adds a new book PUT /:id id, title, publisher, license Updated book Updates an existing book DELETE /:id id 204 Deletes an existing book { "id": 1, "title": "Prealgebra", "publisher": "OpenStax", "license": "License v4.0", "access_link": "https://openstax.org/details/books/prealgebra", "thumbnail": "https://d3bxy9euw4e147.cloudfront.net/oscms-prodcms/media/documents/prealgebra_1.svg", "description": "Prealgebra is designed to meet scope and sequence requirements for a one-semester prealgebra course. The book’s organization makes it easy to adapt to a variety of course syllabi. The text introduces the fundamental concepts of algebra while addressing the needs of students with diverse backgrounds and learning styles. Each topic builds upon previously developed material to demonstrate the cohesiveness and structure of mathematics.", "tag": "Math", "reviews": [ { "id": 1, "review": "Very detailed and thorough, the explanations in this book helped me understand JS. Finding this resource was like taking a breath of fresh air.", "stars": 5, "username": "admin", "name": "Henry Blevins" } ], "authors": [ { "id": 1, "name": "Lynn Marecek" }, { "id": 2, "name": "MaryAnne Anthony-Smith" } ], "stars": 5 }
Method Endpoint Requires Returns Description GET / nothing Array of all reviews Used to get all reviews POST / review, reviewer_id, book_id, stars 201 Adds a new review PUT /:id id, review, reviewer_id, book_id, stars Updated review Updates an existing review DELETE /:id id 204 Deletes an existing review { id: 0, review: "", stars: 3, reviewer_id: 1, book_id: 2, }
Method Endpoint Requires Returns Description GET / nothing Array of all users Used to get all users GET /:id id Single user Get a single user with its wishlist { id: 0, name: "John Doe", username: "jdoe1", }
{ "id": 1, "name": "Henry Blevins", "username": "admin", "password": "$2a$16$zSuXI2ZzPhhhOSKhJguf.Oor37uO9BnPNbTPK7.Q6ILxnlyoJJYie", "books": [ { "id": 1, "title": "Prealgebra", "publisher": "OpenStax", "license": "License v4.0", "access_link": "https://openstax.org/details/books/prealgebra", "thumbnail": "https://d3bxy9euw4e147.cloudfront.net/oscms-prodcms/media/documents/prealgebra_1.svg", "description": "Prealgebra is designed to meet scope and sequence requirements for a one-semester prealgebra course. The book’s organization makes it easy to adapt to a variety of course syllabi. The text introduces the fundamental concepts of algebra while addressing the needs of students with diverse backgrounds and learning styles. Each topic builds upon previously developed material to demonstrate the cohesiveness and structure of mathematics.", "tag": "Math", "reviews": [ { "id": 1, "review": "Very detailed and thorough, the explanations in this book helped me understand JS. Finding this resource was like taking a breath of fresh air.", "stars": 5, "username": "admin", "name": "Henry Blevins" }, { "id": 12, "review": "123", "stars": 4, "username": "melqui", "name": "melqui" } ], "authors": [ { "id": 1, "name": "Lynn Marecek" }, { "id": 2, "name": "MaryAnne Anthony-Smith" } ], "stars": 4.5 }, { "id": 2, "title": "Precalculus", "publisher": "OpenStax", "license": "License v4.0", "access_link": "https://openstax.org/details/books/precalculus", "thumbnail": "https://d3bxy9euw4e147.cloudfront.net/oscms-prodcms/media/documents/precalculus.svg", "description": "Precalculus is adaptable and designed to fit the needs of a variety of precalculus courses. It is a comprehensive text that covers more ground than a typical one- or two-semester college-level precalculus course. The content is organized by clearly-defined learning objectives and includes worked examples that demonstrate problem-solving approaches in an accessible way.", "tag": "Math", "reviews": [ { "id": 2, "review": "I really appreciate the pragmatic approach to REST API's. The book really helped my understanding of REST and web API design in general. Easy read.", "stars": 4, "username": "admin", "name": "Henry Blevins" } ], "authors": [ { "id": 3, "name": "Jay Abramson" } ], "stars": 4 } ] }
Method Endpoint Requires Returns Description GET / nothing Array of all users and their wishlist Used to get all wishlists POST / book_id, user_id 201 Adds a new item DELETE /:id id 204 Deletes an existing item { id: 1, book_id: 1, user_id: 1 }