Skip to content

Latest commit

 

History

History
129 lines (90 loc) · 3.95 KB

README.md

File metadata and controls

129 lines (90 loc) · 3.95 KB
Raw

AMAZING BOB

This is an open-source Django-based web application designed to streamline project management for teams and organizations. It allows you to manage projects, tasks, clients, employees, positions, and billing all in one place.

📚 USED TECHNOLOGIES

  • Django: A powerful web framework for building the backend and frontend.
  • SQLite: Default database for storing application data.
  • Bootstrap: To enhance the UI and make it responsive (optional).
  • Python: The core programming language used for development.

📘 FEATURES

Core Functionality:

  1. Projects:
    • Create and view detailed project information, including title, start/end dates, associated employees, tasks, and bills.
  2. Clients:
    • Manage client details such as name, company, and contact information.
  3. Employees:
    • Add and update employee details and roles.
  4. Positions:
    • Create and manage different positions, including titles, salaries, and job descriptions.
  5. Jobs:
    • Track tasks assigned to projects with relevant notes.
  6. Billing:
    • Manage invoices and associate them with specific projects.

🖥️ APPLICATION PAGES

  1. Dashboard:
    Displays all ongoing and completed projects, sorted by status and deadline.
  2. Project Details:
    A detailed page for each project, including assigned employees, jobs, and linked bills.
  3. Client Management:
    View and edit client information.
  4. Employee Directory:
    A comprehensive list of all employees and their respective roles.
  5. Position Management:
    Create, view, and edit job positions, including salaries and responsibilities.
  6. Job Tracking:
    View and manage all tasks related to projects.
  7. Billing Overview:
    List of invoices issued, with links to their corresponding projects.

🌟 ROADMAP

1. Initial Setup

  • Configure the Django project and app structure.
  • Create models for Project, Client, Employee, Position, Job, and Bill.
  • Implement admin panel functionality for easy data management.

2. Core Features

  • Set up project CRUD (Create, Read, Update, Delete) functionality.
  • Build views and templates for detailed project pages.
  • Implement Many-to-Many relationships for employees and projects.
  • Add filtering and search functionality for projects.
  • Implement position management for employees.

3. Enhanced Features

  • Create a dashboard to display all projects in a single view.
  • Add notifications or alerts for upcoming deadlines.
  • Integrate reporting for total costs and overdue bills.

4. Future Enhancements

  • Add user authentication with different roles (e.g., Admin, Manager, Employee).
  • Enable file uploads for projects (e.g., project-related documents).
  • Integrate external APIs for financial or calendar services.

🛠️ HOW TO RUN LOCALLY

  1. Clone the repository:
git clone https://github.com/your-repository/project-management.git  
cd project-management
  1. Set up the virtual environment:
python -m venv .venv  
source .venv/bin/activate  # For Windows: .venv\Scripts\activate  
pip install -r requirements.txt
  1. Run migrations:
python manage.py migrate
  1. Start the development server:
python manage.py runserver
  1. Access the app:
    Open your browser and navigate to http://127.0.0.1:8000/.

🤝 CONTRIBUTING

Contributions are welcome! Feel free to submit a pull request or report an issue.

📞 CONTACT US

If you have any questions or suggestions, reach out to us at [email protected].

GitHub Stars
Follow Us