Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

85 lines (53 loc) · 1.71 KB

Contributing to General Scheduler

Thank you for your interest in contributing to the General Scheduler project! This document provides guidelines for getting started with development.

Installation

To get started, you need to set up both the backend and frontend servers. Follow the instructions below for each.

Backend Server

  1. Navigate to the solver directory:

    cd solver
  2. Install the required Python packages:

    pip install -r requirements.txt
  3. Run the backend server:

    python3 app/main.py

Frontend Server

  1. Navigate to the webapp directory:

    cd webapp
  2. Install the required Node.js packages:

    npm install
  3. Start the frontend server:

    npm start

Contributing

  1. Fork the repository and clone your fork locally.

  2. Create a new branch for your feature or bug fix:

    git checkout -b your-branch-name
  3. Make your changes and test them.

  4. Commit your changes with a descriptive commit message:

    git commit -m "Description of your changes"
  5. Push your branch to your fork:

    git push origin your-branch-name
  6. Create a pull request on GitHub from your forked repository to the original repository.

Code of Conduct

Please adhere to our Code of Conduct while contributing to the project.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Contact

If you have any questions, feel free to reach out to the project maintainers.

Thank you for contributing to General Scheduler!