Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vishalthehuman/academia-campus-repository

css database django django-application django-web-application django-webapp email-client email-sender html javascript python python-application python3 repository repository-management sql

Last synced: about 14 hours ago
JSON representation

Host: GitHub
URL: https://github.com/vishalthehuman/academia-campus-repository
Owner: VishalTheHuman
License: mit
Created: 2023-10-12T10:01:27.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-07-01T04:21:04.000Z (5 months ago)
Last Synced: 2024-07-05T15:49:03.235Z (4 months ago)
Topics: css, database, django, django-application, django-web-application, django-webapp, email-client, email-sender, html, javascript, python, python-application, python3, repository, repository-management, sql
Language: JavaScript
Homepage: https://youtu.be/vioMw9ywAos
Size: 35.6 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ```Academia - Campus Repository : Django 📔```

![banner](assets/banner.png)

## ```Description```

Academia is a Django-based Campus Repository designed to streamline the file-sharing process between teachers and students. The platform offers distinct homepages for both teachers and students, each tailored to their specific needs. Teachers can efficiently manage files, set permissions, and maintain control over their uploads. On the other hand, students gain easy access to educational resources and a seamless file search experience.

## ```Features```

### Teacher Homepage

- **Upload Files:**
Teachers can upload files directly to the repository, making educational materials easily accessible to students. 📤

- **Delete Files:**
Teachers have the capability to remove files, ensuring content relevance and organization within the repository. 🗑️

- **Set Permission Access:**
Control file access by setting permission levels. Teachers can manage who can view and download their uploaded files. 🔒

- **File Filtering:**
Teachers can view only the files they have uploaded, creating a personalized and organized experience. 📂

### Student Homepage

- **View All Files:**
Students have access to a comprehensive list of all files uploaded by teachers, facilitating easy discovery of educational resources. 👀

- **Download Files:**
Students can download files uploaded by teachers, enabling offline access to course materials. 📥

- **Search Functionality:**
An efficient search feature allows students to find files by their names, making it simple to locate specific educational resources. 🔍

## ```Tech Stack```

- **Django:**
The web application is built using the Django framework, providing a robust and scalable foundation for campus repository management. 🐍

- **Python:**
The backend logic and functionality are implemented using Python, ensuring a clean and efficient codebase. 🐍

- **SQLite Database:**
The project utilizes SQLite for database management, offering a lightweight and easily deployable solution. 🗃️

- **HTML/CSS/JavaScript:**
The frontend is designed using a combination of HTML, CSS, and JavaScript to create a user-friendly and responsive interface. 🌐

## ```Setup```

Step-by-step instructions to set up and run the project.

### Prerequisites

1. **Download Python:**
- Visit the [Python Download Page](https://www.python.org/downloads/) to download the latest version of Python.
- Follow the installation instructions for your operating system.

2. **Get Pip:**
- Pip usually comes bundled with Python installations after version 3.4. If you need to install or upgrade it, follow the instructions on the [Pip Installation Guide](https://pip.pypa.io/en/stable/installation/).

### Project Setup

3. **Install Django:**
- Open a terminal or command prompt.
- Run the following command to install Django:

```bash
pip install django
```

4. **Install SMTPMail and MIME:**
- Run the following commands to install the required packages:

```bash
pip install smtpmail
pip install mime
```

5. **Set Absolute URLs for Images:**
- Open `login/views.py` and `teacherhome/views.py`.
- Locate the URL for `textLogo.png` in both files.
- Replace the relative URL with an absolute URL. Example:

```python
# Before
img_url = 'textLogo.png'

# After
img_url = 'D:/path/to/the/image'
```

6. **Change Gmail and Password**
- Open `login/views.py` and `teacherhome/views.py`.
- Locate the URL for `MAIL_ID` and `PASSWORD` in both files.
- Change the password and email to your desired one. Refer here : [Steps to Create App Password : Google](https://support.google.com/accounts/answer/185833?hl=en)

```python
MAIL_ID = "ENTER_YOUR_GMAIL"
PASSWORD = "xxxx xxxx xxxx xxxx"
```
### Database Setup

7. **Run Migrations:**
- In the root directory of your project, run the following commands to set up the database:

```bash
python manage.py makemigrations
python manage.py migrate
```

### Run the Project

8. **Start the Development Server:**
- Run the following command to start the development server:

```bash
python manage.py runserver
```
- Visit `http://localhost:8000/` in your web browser to view the project.

## ```User Interface (UI) and Email Client```

![login](assets/login.png)
![signup](assets/signup.png)
![no access](assets/no%20access.png)
![404](assets/404.png)
![student home](assets/student%20home.png)
![teacher home](assets/teacher%20home.png)
![file notification](assets/file%20notification.png)

## ```Getting Started```

To set up and run Academia locally, follow the instructions in the [Project Setup Guide](#) provided in the repository.

## ```Contributing```

Contributions are welcome! 🤝

## ```License```

This project is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute the code as per the terms of the license. 📄