Welcome to STUDIUM (2025 Release)

Before I go on and on about this project,

Let me take a moment to thank y'all for giving me such a great opportunity to create, host and share the website of my dreams. Whether you're a student from High Seas, a Staff Member from Hackclub or a Nest user who decided to look at my repo, I would like to thank all of you for making this website possible.

If you are from High Seas, visit this page for a sample article.

Description

Studium is an open-source website that aims to help students study and learn. It combines the simplicity of Flask with an intuitive interface to provide access to educational materials, tools, and resources that promote better learning experiences.

---

Usage

Studium is a website built on the Flask Framework. Hence, to use it locally, you will need Python installed (version 3.13.1 recommended). You can clone this repository using:

git clone https://github.com/Harshal-ACSI/Flask_Studium.git

or

_{This only works with Github CLI}

gh repo clone Harshal-ACSI/Flask_Studium

or

You can directly download as zip file

It is recommended that you use a virtual environment for this project.

pip install virtualenv

# In PowerShell (Windows)
venv\Scripts\Activate.ps1
# In cmd.exe (Windows)
venv\Scripts\activate.bat
# In Linux/Macos
source myvenv/bin/activate

You will also need to install the dependencies listed in requirements.txt. Run the following command on the terminal to automatically install dependencies:

pip install -r requirements.txt

Now you should be able to run the website locally using:

flask run

You can visit the website using port 4777.

---

License

This project has been licensed using a GPL v2 License. Here are the requirements and recommendations, along with what you are allowed to do with this code.

Requirements:

1. The source code of the modified code should be open source.
2. The repository should still be licensed under the GPL v2 license.
3. You cannot impose any additional restrictions beyond those outlined in the GPL v2 license.
4. If you modify the software, you must include a prominent notice stating the changes you made and the date of those changes.

You are allowed to:

• Use the code commercially
• Modify the code
• Distribute copies of the modified code (As long as it still retains the GPL v2 license)

You are NOT allowed to:

• Claim this code as your own and only yours
• Use this code for malicious acts that harm others.
• Use this code for purposes not permitted under the GPL v2 license.

For more information, refer to the LICENSE file

Please also note that the content on the webpage is still copyright protected by the author. So, please change the content in the library directory.

---

Support

Help

If you need help, feel free to open a new discussion in Discussions.The developers will reply to you soon.

Personal Help

If your message contains personal data or if you do not wish to share your message with the public, email us directly at studium@hackclub.app. However, please note that this will take longer periods of time to notice and the response might be slower.

---

Contributing

Please visit the CONTRIBUTING file.

Code of Conduct

Please visit the CODE_OF_CONDUCT file.