-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md
161 lines (100 loc) · 7.54 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<p id="top" align="center">
<a href="https://cse-aiml.live?ref=logo-github" target="_blank">
<img src="static/assets/img/logo-AcademicHub.png" alt="Logoo" width="300" height="100">
</a>
</p>
<h1 align="center" class="dotted">
<a href="https://cse-aiml.live?ref=logo-name-github" target="_blank">
AcademicHub
</a>
</h1>
<br>
<p align="center">
<img src="https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/Django-092E20?logo=django&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoft-sql-server&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/firebase-FFCA28?logo=firebase&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/Html5-E34F26?logo=html5&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/Css3-1572B6?logo=css3&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/Bootstrap-563D7C?logo=bootstrap&logoColor=white&style=for-the-badge" />
<img src="https://img.shields.io/badge/Github-181717?logo=github&logoColor=white&style=for-the-badge" />
<a href="https://github.com/PrathmeshSoni">
<img src="https://badges.pufler.dev/visits/prathmeshsoni/AcademicHub?label=VISITOR&style=for-the-badge&logoColor=FFFFFF&color=purple&labelColor=640464&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IndoaXRlIiB2ZXJzaW9uPSIxLjEiIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgdmlld0JveD0iMCAwIDE2IDE2IiBjbGFzcz0ib2N0aWNvbiBvY3RpY29uLWV5ZSIgYXJpYS1oaWRkZW49InRydWUiPjxwYXRoIGQ9Ik04IDJjMS45ODEgMCAzLjY3MS45OTIgNC45MzMgMi4wNzggMS4yNyAxLjA5MSAyLjE4NyAyLjM0NSAyLjYzNyAzLjAyM2ExLjYyIDEuNjIgMCAwIDEgMCAxLjc5OGMtLjQ1LjY3OC0xLjM2NyAxLjkzMi0yLjYzNyAzLjAyM0MxMS42NyAxMy4wMDggOS45ODEgMTQgOCAxNGMtMS45ODEgMC0zLjY3MS0uOTkyLTQuOTMzLTIuMDc4QzEuNzk3IDEwLjgzLjg4IDkuNTc2LjQzIDguODk4YTEuNjIgMS42MiAwIDAgMSAwLTEuNzk4Yy40NS0uNjc3IDEuMzY3LTEuOTMxIDIuNjM3LTMuMDIyQzQuMzMgMi45OTIgNi4wMTkgMiA4IDJaTTEuNjc5IDcuOTMyYS4xMi4xMiAwIDAgMCAwIC4xMzZjLjQxMS42MjIgMS4yNDEgMS43NSAyLjM2NiAyLjcxN0M1LjE3NiAxMS43NTggNi41MjcgMTIuNSA4IDEyLjVjMS40NzMgMCAyLjgyNS0uNzQyIDMuOTU1LTEuNzE1IDEuMTI0LS45NjcgMS45NTQtMi4wOTYgMi4zNjYtMi43MTdhLjEyLjEyIDAgMCAwIDAtLjEzNmMtLjQxMi0uNjIxLTEuMjQyLTEuNzUtMi4zNjYtMi43MTdDMTAuODI0IDQuMjQyIDkuNDczIDMuNSA4IDMuNWMtMS40NzMgMC0yLjgyNS43NDItMy45NTUgMS43MTUtMS4xMjQuOTY3LTEuOTU0IDIuMDk2LTIuMzY2IDIuNzE3Wk04IDEwYTIgMiAwIDEgMS0uMDAxLTMuOTk5QTIgMiAwIDAgMSA4IDEwWiI+PC9wYXRoPjwvc3ZnPg==">
</a>
</p>
🎓🔗 AcademicHub: Streamline student connectivity and insights with powerful features. 📊
# Live Demo 👇:
<a href="https://cse-aiml.live?ref=live-link-github" target="_blank">cse-aiml.live</a>
<br>
## Table Of Contents :
* [About the Project](#About-The-Project)
* [Technologies Used](#technologies-used)
* [Features](#Features)
* [Getting Started](#Getting-Started)
* [Prerequisites](#Prerequisites)
* [Installation](#installation)
* [Credentials](#Default-Credentials)
* [Screenshots](#Screenshots)
* [Contributors](#Contributors)
* [Connect Me](#Connect-with-me-at)
## About The Project
Introducing AcademicHub, a dynamic web application designed to streamline the academic journey for college students. With a focus on transparency and connectivity, this platform offers a comprehensive view of academic information for all students across various departments. From academic performance insights to a dedicated confession and notes section, AcademicHub fosters a sense of community and engagement.
## Technologies Used
- **Backend**: Python & Django for robust functionality.
- **Data Handling**: Pandas for enhancing data handling capabilities.
- **Frontend**: HTML, CSS, & Bootstrap for a responsive and visually appealing interface.
- **Interactivity**: JavaScript, jQuery, & AJAX for dynamic content and engaging user experience.
- **Database**: MySQL for reliable data storage and management.
- **Notifications**: Google Firebase for sending real-time notifications.
## Features
- **Academic Transparency**: View and download academic records for all students across departments.
- **Confession Page**: An interactive space for students to share confessions and add comments.
- **Notes and Important Updates**: Stay informed with a dedicated section for essential announcements and updates.
- **Subject Result Upload**: Effortlessly upload subject results in CSV format, utilizing an API that converts PDFs to CSV and seamlessly inserts data into the database.
- **Notifications**: Use Google Firebase to send real-time notifications for important updates and announcements.
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
Install Python 3.7 or above
* <a href="https://python.org/downloads/" target="_blank">Python</a>
### Installation
1. Clone the repository: `git clone https://github.com/prathmeshsoni/AcademicHub.git && cd AcademicHub`
2. Create & Activate virtual environment: `python -m venv .venv && .venv\Scripts\activate.bat`
3. Install dependencies: `pip install -r requirements.txt`
4. Launch the Django development server: `python manage.py runserver`
Visit [`http://127.0.0.1:8000`](http://localhost:8000) in your browser. The app should be up & running.
## Default Credentials
[`http://127.0.0.1:8000/admin/`](http://localhost:8000/admin/)
- **Admin Credentials:**
- Enrollment: admin
- Password: User@1234
## Screenshots
Visit our <a href="https://private-app.prathmeshsoni.works/view/118?ref=screenshots-github" target="_blank">Screenshots Page</a> for a visual walkthrough of the AcademicHub Website.
<br />
## Contributors
Thanks to these wonderful people for their contributions:
|  |  |  |  |  |
|:------------------------------------------:|:------------------------------------:|:-----------------------------------------------:|:--------------------------------------:|:------------------------------------------------:|
| [Manthan](https://github.com/mdakbari) | [Vraj](https://github.com/311vraj) | [Parshad](https://github.com/parshadpatel19) | [Janak](https://github.com/janakDobariya) | [Param](https://github.com/1paramsworld) |
<br />
The repository is a starting point for most of my professional projects; for this, I'm using it as a part of my portfolio, feel free to use it wherever you want. I'll be happy if you provide any feedback code improvements or suggestions.
## Connect with me at
<p align='center'>
<a href="https://www.linkedin.com/in/PrathmeshSoni/" target="_blank">
<img src="https://img.shields.io/badge/linkedin-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white" />
</a>
</p>
<p align='center'>
📫 How to reach me: <a href='mailto:[email protected]'>[email protected]</a>
</p>
## All Set :)
<p style="float:left;" align="left">
<a href="#top">Back To Top</a>
</p>
<p style="text-align:right;" align="right">
<a href="https://github.com/PrathmeshSoni/AcademicHub" target="_blank">Back To Repository</a>
</p>
---
**<a href="https://cse-aiml.live?ref=footer-github" target="_blank">AcademicHub</a>** - Provided by **<a href="https://prathmeshsoni.works?ref=footer-github" target="_blank">Prathmesh Soni</a>**