Skip to content

caffeine-addictt/edutecx

Contributors Forks Stargazers Issues BSD-3-Clause License


EduTecX

Paving sustainable education pathways
Report Bug · Live Demo

About The Project

Application Development project @ Nanyang Polytechnic Singapore

This project aims to provide more environmental-friendly education materials. By bridging the gap between vendors, educators and students, we aim to make the learning process more sustainable and accessible.

To saving children's backs!


Warning

This project will not be maintained after 12/02/2024. However, issues and pull requests will still be accepted.


Contributors


Live the live demo here.

(back to top)

Getting Started

This is an example of how you may set up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • Python 3.11.2+

Installation

Below is an example of how you can install and set up your app.

  1. Clone the repository
    git clone https://github.com/caffeine-addictt/edutecx
    cd edutecx
  2. Install dependencies
    pip install -r requirements.txt
  3. Write environment variables
    echo "ENV=development" >> .env
  4. Start the server
    gunicorn --bind 0.0.0.0:8080 --workers=2 --threads=2 --worker-class=gthread --reload run:app

(back to top)

Roadmap

  • Release

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. ( ˶ˆᗜˆ˵ )

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU GENERAL PUBLIC LICENSE. See LICENSE for more information.

(back to top)

Contact

(back to top)