Book Directory

Overview

Book Directory is a simple web application that allows users to search for and manage books in a personal collection. The application integrates with the Google Books API to fetch book information and provides user authentication, allowing users to sign up, log in, and manage their book collections.

Preview URL

Click Me! (Non-active)

Features

• Search Books: Search for books using the Google Books API.
• User Authentication: Sign up, log in, and log out functionality.
• Manage Collections: Users can add books to their personal collection or favorites and view them.
• Responsive Design: The application is responsive and works well on various devices.

Technologies Used

• Backend: Node.js, Express.js, MongoDB
• Frontend: EJS (Template Engine), Tailwind CSS
• API Integration: Google Books API
• Session Management: Express-Session

Installation

1. Clone the repository:

   git clone https://github.com/zkaraqy/book-directory.git

2. Navigate to the project directory:

   cd book-directory

3. Install the dependencies:

   npm install

4. Set up environment variables:

   • Create a .env file in the root directory.
   • Add the following environment variables:

     PORT=3000
     DB_URI=your_mongodb_connection_string
     

5. Start the application:

   npm start

6. Open your browser and go to http://localhost:3000.

Usage

• Sign Up: Create a new user account.
• Log In: Log in with your credentials.
• Search for Books: Use the search bar to find books by title.
• Add to Collection: Save books to your personal collection or favorites.
• View Collection: Access your collection from your profile.

Folder Structure

• config/: Configuration files for the database, session, and other settings.
• controllers/: Handles the application's business logic.
• middleware/: Custom middleware functions.
• public/: Static files such as CSS, JavaScript, and images.
• routes/: Route definitions for the application.
• services/: Services like the Google Books API integration.
• utils/: Utility functions used across the application.
• views/: EJS templates for rendering the UI.

Contributing

Feel free to fork this repository, make changes, and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

License

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