Skip to content

Join our friendly GitHub repository for Hacktoberfest and contribute your skills to make a positive impact!

Notifications You must be signed in to change notification settings

OnVTech-Community/ERP-Portal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 

Repository files navigation

πŸš€ ERP-Portal

πŸŽ‰ Join our friendly GitHub repository for Hacktoberfest and contribute your skills to make a positive impact!

ERP Portal is an enterprise resource planning (ERP) system designed to efficiently manage essential business operations. It offers multiple user roles and features tailored for administrators, users, and employees, streamlining authentication, employee and user management, and profile handling.

🌟 Features

  • Admin Dashboard: Manage system settings, view and manage users and employees.
  • User Dashboard: Personalized portal for accessing available features and updates.
  • Employee Dashboard: View attendance, update profiles, and access work-related resources.
  • Authentication: Secure login and registration system for all user roles.
  • Employee List: Admin can view, add, edit, and delete employee records.
  • User List: Admin can manage all registered users.
  • Profile Management: Users and employees can view and update their profiles.

πŸ›  Tech Stack

  • Backend:
    • Laravel (PHP)
    • Spring Boot (Java)
    • Node.js (Express.js - MERN)
  • Frontend: React.js (MERN Stack)
  • Database:
    • MongoDB (MERN Stack)
    • MySQL (Laravel, Spring Boot)
  • UI: Bootstrap, Tailwind CSS

βš™οΈ Installation

  1. Clone the repository:

    git clone https://github.com/OnVTech-Community/ERP-Portal.git
  2. Install dependencies:

    • For MERN (Node.js) application:
      npm install
    • For Laravel:
      composer install
    • For Spring Boot: Ensure you have Maven or Gradle configured.
  3. Set up the environment variables:

    • Create .env files for each part of the stack and configure the database and API URLs.
  4. Start the development servers:

    • Laravel:
      php artisan serve
    • Spring Boot:
      ./mvnw spring-boot:run
    • MERN Frontend:
      npm run dev

🌱 Contribution Guidelines

πŸŽƒ Hacktoberfest Contributions:

We encourage developers to contribute to this project as part of Hacktoberfest. You can help by adding new features, fixing bugs, improving documentation, or optimizing existing code.

How to Contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add feature-name"
  4. Push to the branch:
    git push origin feature-name
  5. Open a Pull Request to the main branch.

πŸ—‚ Project Management

We are using a GitHub Project Board to manage tasks and track progress for the ERP Portal development.

How to Access the Project Board:

  1. Go to the "Projects" tab in this repository.
  2. Click on the ERP Project Board.
  3. The board is organized into the following columns:
    • Backlog: All pending tasks.
    • To Do: Tasks that are ready to be worked on.
    • In Progress: Tasks currently under development.
    • Testing: Tasks that are under testing or review.
    • Deployment: Tasks related to deploying features.
    • Done: Completed tasks.

🎯 Expected Outcome:

By contributing to the ERP Portal, you will help build a robust, fully functional ERP system that includes admin, user, and employee roles, authentication, and profile management features.

πŸ“œ License

This project is licensed under the MIT License. See the LICENSE file for more information.