Helpupil is a platform where users can upload documents and make them available for other users to learn. For uploading files you get points, but only if they are marked as valid by a moderator. With these points one can compete with other users on a leaderboard. Other users of the platform can spend points to get access to documents for further education.
Explore the API docs »
View Demo
·
Report Bug
·
Request Feature
To get a local copy up and running follow these simple steps:
- npm
npm install npm@latest -g
You will need:
- JetBrains IntelliJ IDEA
- Maven/An active internet connection
- Oracle JDK / Open JDK with version 15.0.1 (or higher)
-
Clone the repo
git clone https://github.com/fabio-anzola/Helpupil.git
-
(API) Install NPM packages
cd server npm install -
(Frontend) Install NPM packages
cd client maven install (within IDE)
- Users can log into their account
- Users can create their own account
- Users can upload their documents
- Users are structured after their Subject / Professor
- Users can download a document
- There is a Point-system evaluating the most contributing users
- Users get points for uploading documents
- There is a leaderboard
- There are different roles
- The API uses a database to store all data
- We support specific file formats: jpg/png/pdf
See the open issues for a list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU AGPL v3.0. See LICENSE for more information.
Project Link: https://github.com/fabio-anzola/Helpupil