Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bookNotes

Book Notes is a webApp where the owner can track records of the books he has read using database where he can store his ratings, summary and notes of the book. image

image

image

Features

  • A new entry can be posted with the book details which are name, ISBN number, rating, Book Summary and finally the Book notes.
  • Any past entry can be edited or deleted using the Edit and Delete buttons.
  • Any past entry can be searched for using the search box at the top right corner of the website where ISBN number or title of the book should be entered.
  • Book Cover is accessed using the Open Library Covers API with the help of ISBN number provided during posting a new entry.

Technologies used

  • NodeJS
  • ExpressJS
  • EJS
  • Postgre SQL
  • REST APIs
  • Bootstrap/CSS

Getting Started

  1. Clone this repository to your local machine.
  2. Navigate to the project directory in your terminal.
  3. Run npm install to install dependencies.
  4. Create a .env file similar to the env.example file and fill in the required values.
  5. Set up your PostgreSQL database and update the .env file with your database credentials. You can create a table in your postgre database using the following command :
    CREATE TABLE tableName (
     id SERIAL PRIMARY KEY,
     title VARCHAR(100) NOT NULL,
     isbn VARCHAR(13) NOT NULL,
     rating SMALLINT NOT NULL,
     summary TEXT DEFAULT 'no summary provided',
     description TEXT DEFAULT 'no notes provided'
    );
    
  6. Run node index.js to start the development server.
  7. Open your web browser and visit http://localhost:3000 to access the Book Notes.

Contributions

Contributions to Book Notes are welcome! In case you have any ideas for new features, improvements, or bug fixes, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

A webApp for keeping record of the books read by the user

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages