Skip to content

Ivangonz/tutornator

Repository files navigation

Contributors Forks Stars Issues Last Commit Code Size

The Tutornator

This is an tutoring schedule manager application written in Flask/Vuejs. The goal for this application is to replace the tutoring schedule manager that currently exists for Weber State University students.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This is an tutoring schedule manager application written in Flask/Vuejs. The goal for this application is to replace the tutoring schedule manager that currently exists for Weber State University students.

Built With

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g
  • poetry
    pip install poetry

Installation

  1. Clone the repo
    git clone https://github.com/Ivangonz/tutornator.git
  2. Create new Python virtual environment (You can also use your IDE to do this)
    python3 -m venv /path/to/new/virtual/environment
  3. Install Python requirements
    poetry install
  4. Install Node modules
    inv build.npmdeps

Running The Program

  1. Run the Flask backend
    inv build.backend
  2. Run the Frontend
    inv build.webapp
  3. Navigate to http://localhost:port/

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Ivangonz/tutornator

Acknowledgements

About

Tutoring schedule manager written in Vue/Flask

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published