takos22 / timathon-for-students

Project for the 2nd Timathon Code Jam themed "For Students"

Timathon - For Students

---

This website is a homework management system made for students, they can add homework, keep track of it and make sure they have everything so they will have good grades. I made a whole website alone around the "For Students" theme with 2 big parts:

• a website
• an API for that website

Doing all this alone was really hard but I somehow managed to pull it off. Make sure to follow my github account at takos22.

📝 Table of Contents

• 📝 Table of Contents
• 🧐 Problem Statement
• 💡 Idea / Solution
• 🎈 Usage
• 🚀 Future Scope
• 🏁 Getting Started
  • Prerequisites
  • Running the project
• ⛏️ Built With
• ✍️ Authors

🧐 Problem Statement

The timathon theme is "For students". So I had to make something that could be useful for students and that could help them in their everyday life.

💡 Idea / Solution

I thought about making an API for homeworks, timetables (not implemented yet) and other things useful to students. However an API alone isn't that easy to use, you would have to write code and not every student can do that, that's why I decided to make a website for it.

Students are able to add homeworks, timetables (not implemented yet) and more things that could help them at school.

🎈 Usage

Go on the website, create your account, then you can use the following functionalities:

• Create and manage homework
• Create and manage your timetable (not implemented yet)

🚀 Future Scope

I'm going to add more endpoints to the API so more functionalities on the website. If you have any ideas/suggestions, you can leave an issue with a feature request tag.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To be able to run the website, you need to first install the required modules with:

pip install -r requirements.txt

Running the project

To run the website you need to first add some environment variables:

• For shell

export DEBUG=1
export SECRET_KEY=secret_key_here

• For cmd

set DEBUG=1
set SECRET_KEY=secret_key_here

Then do the database migrations:

py manage.py migrate

Then run the server:

py manage.py runserver

⛏️ Built With

• Python - Language
• Django - Backend for the API and website
• Bootstrap - Frontend styling framework
• Heroku - Hosting

✍️ Authors

• @takos22 - Idea & Coding

timathon-for-students's Issues

login

Due Date:

A suggestion : Instead of just storing dd-mm-yyyy store seconds-minutes-hours-day-months-year

cause then it also allows you to schedule your day. Otherwise, it's pretty wholesome!