Documentation

Choice of Platform

we chose to build a web platform inorder to reach a bigger audience of college students, professors, and the working staff. It also enables us to target mobile phone users through the web browser.

Requirements

Backend Languages, Frameworks and Plugins

Python 3
Flask
- WTForms
- WTF-Forms
- Flask-Login
- Flask-Migrate
- Flask-SQLAlchemy
- Jinja2

Frontend Languages, Frameworks and Libraries

HTML
CSS
Javascript
FullCalendar.js
w3css

Running The Server

Install all the requirements.
Error Logging server: open a terminal and run the following command:
```
python3 -m smtpd -n -c DebuggingServer localhost:8025
```

Run the server: open another terminal and from the project root folder (WHEREVER_THE_PROJECT_IS_LOCATED/ABC/) run the following commands:

export MAIL_SERVER=localhost
export MAIL_PORT=8025
export FLASK_APP=run.py
export FLASK_DEBUG=0
export SQLALCHEMY_DATABASE_URI='/model/database.db'
flask run

Open a browser and enter the url: localhost:5000

Main Idea and Concept

We tackled challenge 3 by creating a feeds/events based system.

For students, each has, by default, a single private feed which he can edit and add events to it. Students are also able to view professors' feeds and subscribe to them as they wish. Unlike students, professors can create many public feeds, which students can subscribe to.

Each user of the system has a profile page, he can edit his name and provide a brief about.

Use Cases

Case 1 : Student Ahmed

Ahmed is a student in third year. Ahmed wishes to be notified for upcoming events, lectures, exams, and announcements. He uses the app to subscribe to professors' feeds that he is interested in. Every time in a while, Ahmed checks his calendar for new events from his feeds. He can also create his own private events to stay organized in his studies.

Case 2 : Professor Tarig

Tarig is a professor in ABC University. Tarig teaches many batches as well as many courses. Using our app, Tarig can create feeds that his students can subscribe to. He can then create events and push it to a specific feed. All his feed subscribers will recieve the event update emmidiately.

Further Work

Events Implementation
Events categories or priorites
Private messages
Public and private feeds
Forums
Chatting

mohammedhashim44 / Hackathon2018