Skip to content

Latest commit

 

History

History
133 lines (108 loc) · 3.6 KB

README.md

File metadata and controls

133 lines (108 loc) · 3.6 KB

PLKIT-BE.platform

Table of Contents

Overview

PLKIT-BE.platform is a backend service built with FastAPI, designed to manage operations for a community and market platform. It includes user authentication, community and market functionalities, and status management. Its modular architecture ensures maintainability and scalability.

Project Structure

PLKIT-BE.platform-develop/
├── crud/                  # CRUD operations for models
│   ├── community.py
│   ├── market.py
│   ├── user.py
│   └── __init__.py
├── models/                # Database models
│   ├── community.py
│   ├── market.py
│   ├── user.py
│   └── __init__.py
├── routers/               # API route handlers
│   ├── auth.py
│   ├── communities.py
│   ├── dummies.py
│   ├── markets.py
│   ├── statuses.py
│   ├── users.py
│   └── __init__.py
├── schemas/               # Pydantic models for validation
│   ├── auth.py
│   ├── community.py
│   ├── market.py
│   ├── user.py
│   └── __init__.py
├── config.py              # Configuration settings
├── database.py            # Database connection and setup
├── main.py                # FastAPI entry point
├── security.py            # Security functions (e.g., JWT handling)
├── requirements.txt       # Python dependencies
└── .gitignore             # Git ignored files

Features

  • User Authentication: JWT-based authentication system.
  • Community and Market APIs: Manage community and market functionalities.
  • Status Management: Handle and update user and service statuses.
  • CORS Support: Enables cross-origin requests.

Getting Started

Prerequisites

  • Python 3.8+
  • Virtual environment tool (venv, virtualenv, conda)

Installation

  1. Clone the repository: bash git clone <repository-url> cd PLKIT-BE.platform-develop

  2. Create and activate a virtual environment: bash python -m venv env source env/bin/activate # On Linux/Mac env\Scripts\activate # On Windows

  3. Install dependencies: bash pip install -r requirements.txt

Running the Server

  1. Set up environment variables: - Create a .env file for sensitive information like database credentials.

  2. Start the server: bash uvicorn main:app --reload

  3. Access API documentation: - Visit http://localhost:8000/docs for interactive API docs.

Dependencies

Listed in requirements.txt:

  • FastAPI
  • Uvicorn
  • SQLAlchemy
  • Cryptography
  • PyJWT
  • ...and others.

Configuration

  • Database: Configured in database.py.
  • Security: JWT tokens handled in security.py.

Contributing

  1. Fork the project.
  2. Create your feature branch: bash git checkout -b feature/AmazingFeature
  3. Commit your changes: bash git commit -m 'Add some AmazingFeature'
  4. Push to the branch: bash git push origin feature/AmazingFeature
  5. Open a pull request.