Praeteritum

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Praeteritum is a web application written in Flask and SvelteKit, designed to help manage retrospects and get feedback from your employees, students, etc... We attempt for this application to be usable in any setting.

The idea originates from the G+SOŠ Hackathon, from a theme set by Certicon. We hope to complete the application, for we would benefit from using it our selves.

(back to top)

Built With

• W.I.P.

(back to top)

Getting Started

To get a local development copy up and running follow these simple example steps.

For production deployments, you can preferably use docker and docker compose, or you can run without containers by following the commands specified in the Dockerfiles. We might make an install guide after the first release.

Prerequisites

You will need NodeJS + npm (for the frontend) and Python >=3.11 + pip (for the backend)

• npm

  npm install npm@latest -g
  

• pip

  pip install --upgrade pip
  

Installation

1. TODO: Write an install guide

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Project Setup
• API
  • Authentication
  • Board Management
  • Page (Question) Management
  • Posts / Comments
    • Votes
  • Board States
  • User Groups
    • Group Invites
  • Authorization
• Frontend
  • Login & Landing Page
  • Dashboard
  • Board View
  • Admin Dashboard
    • User Management
    • Board Management
    • Group Management
      • Invite Overview
    • Branding Configuration
    • Logs? May be dropped in the future
  • Mobile UI
• First 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

We are still deciding on a license. See LICENSE.txt for more information in case this file wasn't updated.

(back to top)

Contact

Project NULL - Join our discord - null@mobilex1122.com

Project Link: https://github.com/ProjNull/Praeteritum

(back to top)

Acknowledgments

• README Template by othneildrew
• Awesome mentors, who were present on the G+SOŠ Hackathon

(back to top)