Code Monkey home page Code Monkey logo

fastapi-ecommerce's Introduction

FASTAPI-ECOMMERCE

Item Management Application

This application allows you to manage items through CRUD (Create, Read, Update, Delete) operations. It provides a set of API endpoints to interact with the items stored in the system.

Features

  • Create: Add new items to the system.
  • Read: Retrieve information about existing items.
  • Update: Modify the details of existing items.
  • Delete: Remove items from the system.

Technologies Used

Getting Started

Prerequisites

  • Python 3.9 or higher
  • PostgreSQL database
  • Virtual environment (optional, but recommended)

Installation

  1. Clone the repository: git clone https://github.com/your-username/item-management-app.git
  2. Navigate to the project directory: cd item-management-app
  3. Create and activate a virtual environment (optional):
    • Linux/Mac: python3 -m venv venv && source venv/bin/activate
    • Windows: python -m venv venv && venv\Scripts\activate
  4. Install the required dependencies: pip install -r requirements.txt
  5. Set up the database connection:
    • Update the database configuration in the config.py file.
  6. Run the application: python main.py
  7. Access the API documentation: http://localhost:8000/docs

Usage

Once the application is up and running, you can use any HTTP client (e.g., cURL, Postman) to interact with the API endpoints.

Create an Item

Send a POST request to /items with the item details in the request body.

Read an Item

Send a GET request to /items/{item_id} to retrieve information about a specific item.

Update an Item

Send a PUT request to /items/{item_id} with the updated item details in the request body.

Delete an Item

Send a DELETE request to /items/{item_id} to remove an item from the system.

Authentication

Some routes may require authentication to access. You need to obtain a JWT token by sending a POST request to /login with valid credentials. Include the token in the Authorization header for authenticated routes (Bearer Token).

License

This project is licensed under the MIT License.

fastapi-ecommerce's People

Contributors

nikitha1203 avatar

Stargazers

KARTHIK KUMAR M 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.