This is the source code for the Student Organizational System, a project by Thomas Patton and Andres Beltran for EECS 393. The goal of the project is to create a system for students in a university to meet for classes. We found that students at university often did not have the proper resources to easily meet with classmates. As a result, we built a website with Python and Django to facilitate this. Registered users have the ability to create meetings for classes and quickly share them with their friends. For a more in-depth look at the purpose of this project, see the Software Requirements Specification document and the Design Document.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Your computer will need to have Python. A good explanation of how to do this is available on the Python Website.
From there, you will need to install a few packages. To handle the website framework, you will need to download Django.
$ pip install Django
To handle the form tags used, install crispy-forms
$ pip install --upgrade django-crispy-forms
And lastly to handle the images, you will need Pillow
$ pip install Pillow
If you intend to check testing and coverage, make sure to install coverage as well
$ pip install coverage
With the repository cloned, you can begin the website from your terminal via
$ python manage.py runsever
From there, navigate to localhost:8000 in your browser of choice. New users will have the option to create profiles while existing users can log in with existing credentials. From there, the program operate as one might expect. Users have the options to create their own study sessions as well as join existing ones. Users also have access to their own profile pages from the dropdown and can quickly and easily modify their information.
When you're finished with the application, simply do a CTRL-C (Command + C on Mac) to close the local server.
See the Wiki files in the repository for a more in depth look at the roadmap of the project and the most recent documentation. This includes our Software Requirements Specification, Testing Documents, and our Design Document.
Our application is primarily built with Python 3.6 using the Django Framework. For the frontend, we used a combination of HTML, CSS, Javascript, and Bootstrap.
The program was primarily developed in PyCharm, with the assistance of Git.
- Andres Beltran - Backend Development Engineer - GitHub
- Thomas Patton - Backend Development Engineer - GitHub
A thanks is also due to Corey Shafer, for his instructional guides on learning the Django framework.
This project is licensed under the MIT License - see the LICENSE.md file for details