Book Library Application

Book Library made with node js and express with important basic features
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact

About The Project

There are many great node applications about implementing the most important CRUD operations but I wanted to make something on my own with the features that I'm looking for, So I came up with that project and also deployed it on Cyclic so you can look on the online version easily on https://yazan-book-library.cyclic.app/

Here's why:

• You should always try to implement what you learn from the courses you take or from the documentation you read
• A book library application with signup and login features would be a great summurize of what I learned in general
• Front-end is no less imprtant than back-end for the full stack developer so I tried to create it based on bootstrap library

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get started clone the repository and read the installation instructions below

Prerequisites

list of things you need to use the software

• npm

  npm install npm@latest -g

• MongoDB installed locally on your PC

Installation

_Below is an example of how you can install and set up the app locally.

1. Clone the repo

   git clone https://github.com/Yazan-Ali-01/Book-Library.git

2. Install NPM packages

   npm install

3. Enter your environment variables in .env.example then change its name to .env only

   const MONGODB_URI = "ENTER YOUR MONGODB_URI";
   const SECRET =
     "ENTER YOUR secret first name to signup as admin account when you signup with that first name";

4. start MongoDB local database server in your terminal with

   mongod

5. start application with npm run start:dev in the terminal
6. Run it in your browser on localhost:3000

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Email: [email protected]

Project Link: https://github.com/Yazan-Ali-01/Book-Library

(back to top)

(back to top)