Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 3.64 KB

README.md

File metadata and controls

84 lines (50 loc) · 3.64 KB
Raw

Odoo-Combat-Hackathon-2024

Welcome to the Odoo-Combat-Hackathon-2024 repository! This project was developed as part of the Odoo Combat Hackathon 2024, and it aims to provide a comprehensive solution for library management and combat-related applications.

🖼️ Project Overview

The Library Management System is a web-based application designed to manage various aspects of a library's operations, including book management, user management, transactions, and reporting. It also integrates features related to combat scenarios for advanced applications.

Screenshots

image

image

image

image

image

image

image

image

image

image

🚀 Tech Stack

The project utilizes a variety of technologies to create a robust and scalable library management system. Here's a detailed list of the tech stack used:

  • Frontend:
    • React: A JavaScript library for building user interfaces.
    • Tailwind CSS: A utility-first CSS framework for creating modern, responsive designs.
  • Backend:
    • FastAPI: A modern, fast (high-performance) web framework for building APIs with Python 3.7+ based on standard Python type hints.
  • Database:
    • MongoDB: A NoSQL database for storing application data.

🏗️ Installation

To set up the project locally, follow these steps:

1. Clone the Repository

2. Install Frontend Dependencies Navigate to the frontend directory and install the required dependencies:

3. Install Backend Dependencies Navigate to the backend directory and install the required dependencies:

4. Set Up the Database Make sure you have MongoDB running locally or have access to a MongoDB instance. Update the config.py file in the backend directory with your database connection details.

5. Run the Application Start the backend server: Start the frontend development server:

🧩 Usage

Once the application is running, you can access it via http://localhost:3000 for the frontend and http://localhost:8000 for the backend API.

  • Librarian Dashboard: Log in as a librarian to view statistics and manage library operations.
  • User Interface: Explore features for searching books, managing borrowings, and paying fines.

🤝 Contributing

We welcome contributions to improve the project! Please follow these steps for contributing:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Commit your changes and push to your forked repository.
  4. Open a Pull Request with a description of your changes.

Contributers

Parth Thakkar: LinkedIn | GitHub Neel Sheth: LinkedIn | GitHub Tirth Patel: LinkedIn | GitHub