Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shashankgupta10/academia
https://github.com/shashankgupta10/academia
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shashankgupta10/academia
- Owner: ShashankGupta10
- Created: 2023-02-11T07:59:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T07:28:59.000Z (over 1 year ago)
- Last Synced: 2023-10-23T15:29:36.979Z (over 1 year ago)
- Language: Python
- Size: 2.44 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Institute Organizing Platform
The Institute Organizing Platform is a comprehensive web application designed to facilitate communication and collaboration between students and educational institutions. It offers a range of features to streamline assignments, meetings, messaging, and announcements.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Features
- **Assignment Submission**: Students can submit assignments through the platform, making it easy for teachers to collect and grade assignments.
- **Video Calls**: Conduct video meetings for lectures, group discussions, or any other educational purposes.
- **Chat**: Real-time chat functionality for communication between teachers and students or among students.
- **Announcements**: An announcement page for colleges or departments to make important announcements to all users.
## Images
## Getting Started
These instructions will help you set up and run the Institute Organizing Platform on your local machine for development and testing purposes. For production deployment, additional steps may be required.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Python 3.x
- MongoDB
- [Additional dependencies listed in requirements.txt](requirements.txt)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/ShashankGupta10/Academia.git
```
2. Change into the project directory:
```bash
cd Academia
```
3. Create a virtual environment and activate it (recommended):
For Windows
```bash
python -m venv venv
venv\Scripts\activate
```
Linux
```bash
source venv/bin/activate
```
4. Install the project dependencies:
```bash
pip install -r requirements.txt
```
5. Set up the MongoDB database and configure the connection in your settings.
6. Run the application:
```bash
python homepage.py
```
## Usage
- Create user accounts for students and teachers.
- Explore the features of the platform, including assignment submission, video calls, chat, and announcements.
## Contributing
We welcome contributions from the community. If you'd like to contribute to this project, please follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name.
3. Make your changes, and ensure the code is well-documented.
4. Test your changes to ensure they work as expected.
5. Submit a pull request back to the main repository.
---
Thank you for using Academia! If you have any questions or encounter any issues, please feel free to open an issue on this repository.