Skip to content

GaneshN523/FirmManagement

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

FirmManagement

FirmManagement is a comprehensive management system designed for firms, factories, and companies to streamline operations from a single centralized dashboard. It leverages FastAPI for the backend, PostgreSQL as the database, and React (Vite.js) for a modern and high-performance frontend.

Features

  • User authentication and role-based access control
  • Dashboard for monitoring firm operations
  • Employee and resource management
  • Inventory and financial tracking
  • Real-time data analytics
  • Scalable and modular architecture

Tech Stack

  • Backend: FastAPI (Python)
  • Database: PostgreSQL
  • Frontend: React with Vite.js
  • Deployment: Docker, AWS/Heroku (optional)

Installation & Setup

Prerequisites

Ensure you have the following installed:

  • Python 3.8+
  • Node.js 16+
  • PostgreSQL
  • Docker (optional)

Steps to Run the Project

Backend (FastAPI)

  1. Clone the repository:
    git clone https://github.com/yourusername/firm-management.git
    cd firm-management/backend
  2. Install dependencies:
    pip install -r requirements.txt
  3. Set up environment variables in a .env file:
    DATABASE_URL=postgresql://user:password@localhost:5432/firm_management_db
    SECRET_KEY=your_secret_key
  4. Run the FastAPI server:
    uvicorn main:app --reload

Frontend (React + Vite.js)

  1. Navigate to the frontend folder:
    cd ../frontend
  2. Install dependencies:
    npm install
  3. Start the development server:
    npm run dev

Deploying to GitHub

To push this project to GitHub, follow these steps:

  1. Initialize Git in your project folder
    git init
  2. Add remote repository
    git remote add origin https://github.com/yourusername/firm-management.git
  3. Add files to staging area
    git add .
  4. Commit the changes
    git commit -m "Initial commit - FirmManagement system"
  5. Push to GitHub
    git branch -M main
    git push -u origin main

Contributing

Feel free to contribute by submitting pull requests or reporting issues.

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors