Giter Club home page Giter Club logo

library-management-system's Introduction

Library-Management-System

Requirements

Before running the FastAPI app, ensure you have the following installed:

  • Python 3.x
  • pip (Python package installer)

Installation

  1. Clone the repository:

    git clone [email protected]:5h15h1r/Library-Management-System.git
    cd Library-Management-System
  2. Create a virtual environment (optional but recommended):

    • On Windows:
    python -m venv venv
    • On macOS and Linux:
    python3 -m venv venv
  3. Activate the virtual environment:

    • On Windows:
    venv\Scripts\activate
    • On macOS and Linux:
    source venv/bin/activate
  4. Install the required dependencies:

    pip install -r requirements.txt

Usage

To start the app locally, follow these steps:

  1. Make sure you are in the root directory of the project.

  2. Run the following command to start the Uvicorn server:

    uvicorn app.server.app:app --reload

    OR

    python3 app/main.py
  3. Open your web browser and navigate to http://localhost:8000

Environment Variables

The following environment variables can be used to configure the FastAPI app:

  • MONGO_URI: The Mongo connection URI used to connect to a self-hosted MongoDB standalone deployment or Mongo Atlas (format: mongodb+srv://[username:password@]host[/[defaultauthdb][?options]]).

You can set these variables as needed before starting the server.

Documentation

Documentation for the API can be accessed through the URL

  • For SwaggerUI
    http://localhost:8000/docs
  • For Redoc
    http://localhost:8000/redoc

library-management-system's People

Contributors

5h15h1r avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.