Kshitij2604 commited on
Commit
f66b4fd
Β·
verified Β·
1 Parent(s): d8514e5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +184 -183
README.md CHANGED
@@ -1,184 +1,185 @@
1
- ---
2
- title: Project Management System
3
- emoji: πŸš€
4
- colorFrom: blue
5
- colorTo: indigo
6
- sdk: docker
7
- sdk_version: "3.9-slim"
8
- app_file: app.py
9
- pinned: false
10
- ---
11
-
12
- # Project Management System
13
-
14
- A web-based project management system for managing student projects across different domains.
15
-
16
- ## Features
17
-
18
- - User Authentication (Student/Faculty)
19
- - Project Management
20
- - Domain-based Project Organization
21
- - Student Project Assignment
22
- - Admin Panel
23
- - Responsive Design
24
-
25
- ## Deployment on Hugging Face Spaces
26
-
27
- 1. Fork this repository
28
- 2. Create a new Space on Hugging Face
29
- 3. Connect your forked repository to the Space
30
- 4. Configure the following environment variables in your Space settings:
31
- ```
32
- DB_HOST=your_database_host
33
- DB_USER=your_database_username
34
- DB_PASSWORD=your_database_password
35
- DB_NAME=your_database_name
36
- ```
37
-
38
- ## Local Development
39
-
40
- 1. Clone the repository
41
- 2. Install Python dependencies:
42
- ```bash
43
- pip install -r requirements.txt
44
- ```
45
- 3. Set up your environment variables in a `.env` file:
46
- ```
47
- DB_HOST=localhost
48
- DB_USER=root
49
- DB_PASSWORD=your_password
50
- DB_NAME=dms
51
- ```
52
- 4. Run the application:
53
- ```bash
54
- python app.py
55
- ```
56
-
57
- ## Database Setup
58
-
59
- 1. Create a MySQL database named 'dms'
60
- 2. Import the database schema from `dms.sql`
61
- 3. Run `create_domain_descriptions.php` to set up domain descriptions
62
-
63
- ## Directory Structure
64
-
65
- ```
66
- β”œβ”€β”€ app.py # Flask application
67
- β”œβ”€β”€ requirements.txt # Python dependencies
68
- β”œβ”€β”€ index.php # Homepage
69
- β”œβ”€β”€ domains.php # Domain listing
70
- β”œβ”€β”€ project_*.php # Project management files
71
- β”œβ”€β”€ admin.php # Admin panel
72
- β”œβ”€β”€ css/ # Stylesheets
73
- β”œβ”€β”€ js/ # JavaScript files
74
- β”œβ”€β”€ includes/ # PHP includes
75
- └── ajax/ # AJAX handlers
76
- ```
77
-
78
- ## Security Considerations
79
-
80
- - All user inputs are sanitized
81
- - Passwords are hashed using secure methods
82
- - Session management is implemented
83
- - Access control is enforced based on user roles
84
-
85
- ## Contributing
86
-
87
- 1. Fork the repository
88
- 2. Create a feature branch
89
- 3. Commit your changes
90
- 4. Push to the branch
91
- 5. Create a Pull Request
92
-
93
- ## License
94
-
95
- This project is licensed under the MIT License - see the LICENSE file for details.
96
-
97
- # Domain Management System
98
-
99
- A web-based platform to explore, search, and view projects across various domains, based on the DMS database.
100
-
101
- ## Features
102
-
103
- - **Browse Domains**: View all available domains in the system and their associated projects.
104
- - **Project Search**: Search for projects by name, description, domain, or type (Hardware/Software).
105
- - **Project Details**: View detailed information about each project, including descriptions, contact information, and associated resources.
106
- - **Student Information**: If the student table exists, search and view student information related to projects.
107
- - **Dynamic Data Fetching**: The system automatically fetches data from parent tables, avoiding manual duplication of data.
108
- - **Domain Descriptions**: Domain descriptions are automatically generated from the database or fallback to defaults.
109
-
110
- ## Setup Instructions
111
-
112
- ### Prerequisites
113
-
114
- - Web server with PHP support (e.g., Apache, Nginx)
115
- - MySQL/MariaDB database server
116
- - PHP 7.0 or higher
117
-
118
- ### Database Setup
119
-
120
- 1. Create a new database named `dms` in your MySQL server:
121
- ```sql
122
- CREATE DATABASE dms;
123
- ```
124
-
125
- 2. Import the SQL file (`dms (2).sql`) into your database:
126
- - Using phpMyAdmin: Go to the Import tab, select the SQL file, and click "Go"
127
- - Using MySQL command line:
128
- ```
129
- mysql -u username -p dms < "dms (2).sql"
130
- ```
131
-
132
- 3. (Optional) Create domain descriptions table:
133
- - Access the `create_domain_descriptions.php` script in your browser to create and populate the domain_descriptions table
134
- - This step is optional but recommended for better organization of domain metadata
135
-
136
- ### Web Application Setup
137
-
138
- 1. Copy all files to your web server's document root (or a subdirectory).
139
- 2. Update the database connection details in `includes/db_connect.php` if needed.
140
- 3. Make sure your web server has permissions to read/write to the files.
141
- 4. Access the website through your web browser.
142
-
143
- ## Database Structure
144
-
145
- The database consists of multiple tables:
146
-
147
- - `domain_1` through `domain_12`: Tables containing projects from different domains
148
- - `students_info`: Table containing student information (if available)
149
- - `domain_descriptions`: Optional table for storing domain descriptions
150
-
151
- Each domain table has a similar structure with fields like:
152
- - `Domain_ID`
153
- - `Project_ID`
154
- - `Project_Name`/`Project _Name`
155
- - `Email`
156
- - `H/S` (Hardware/Software)
157
- - `Description`
158
- - `Links`
159
-
160
- ## Dynamic Data Handling
161
-
162
- The system uses several utility functions to automatically fetch and process data:
163
-
164
- - **Domain Descriptions**: Automatically fetched from the domain_descriptions table if it exists, otherwise falls back to default values
165
- - **Project Names**: The system handles different column naming conventions across tables
166
- - **Cross-Domain Search**: Searches can be performed across all domain tables simultaneously
167
- - **Student-Project Association**: Student data is linked dynamically to projects for comprehensive viewing
168
-
169
- ## Usage
170
-
171
- 1. **Home Page**: View basic statistics and recent projects from all domains
172
- 2. **Domains Page**: Browse all domains and access their projects
173
- 3. **Projects Page**: Search for projects across all domains with advanced filtering
174
- 4. **Students Page**: Search for students by name, division, or domain (if the table exists)
175
-
176
- ## Troubleshooting
177
-
178
- - If you encounter database connection errors, verify that the credentials in `includes/db_connect.php` are correct.
179
- - Make sure that the `dms` database has been properly imported with all required tables.
180
- - Check your PHP error logs if you're experiencing issues with the website.
181
-
182
- ## Credits
183
-
 
184
  Created as a Database Management System project.
 
1
+ ---
2
+ title: Project Management System
3
+ emoji: πŸš€
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: gradio
7
+ sdk_version: "3.52"
8
+
9
+ app_file: app.py
10
+ pinned: false
11
+ ---
12
+
13
+ # Project Management System
14
+
15
+ A web-based project management system for managing student projects across different domains.
16
+
17
+ ## Features
18
+
19
+ - User Authentication (Student/Faculty)
20
+ - Project Management
21
+ - Domain-based Project Organization
22
+ - Student Project Assignment
23
+ - Admin Panel
24
+ - Responsive Design
25
+
26
+ ## Deployment on Hugging Face Spaces
27
+
28
+ 1. Fork this repository
29
+ 2. Create a new Space on Hugging Face
30
+ 3. Connect your forked repository to the Space
31
+ 4. Configure the following environment variables in your Space settings:
32
+ ```
33
+ DB_HOST=your_database_host
34
+ DB_USER=your_database_username
35
+ DB_PASSWORD=your_database_password
36
+ DB_NAME=your_database_name
37
+ ```
38
+
39
+ ## Local Development
40
+
41
+ 1. Clone the repository
42
+ 2. Install Python dependencies:
43
+ ```bash
44
+ pip install -r requirements.txt
45
+ ```
46
+ 3. Set up your environment variables in a `.env` file:
47
+ ```
48
+ DB_HOST=localhost
49
+ DB_USER=root
50
+ DB_PASSWORD=your_password
51
+ DB_NAME=dms
52
+ ```
53
+ 4. Run the application:
54
+ ```bash
55
+ python app.py
56
+ ```
57
+
58
+ ## Database Setup
59
+
60
+ 1. Create a MySQL database named 'dms'
61
+ 2. Import the database schema from `dms.sql`
62
+ 3. Run `create_domain_descriptions.php` to set up domain descriptions
63
+
64
+ ## Directory Structure
65
+
66
+ ```
67
+ β”œβ”€β”€ app.py # Flask application
68
+ β”œβ”€β”€ requirements.txt # Python dependencies
69
+ β”œβ”€β”€ index.php # Homepage
70
+ β”œβ”€β”€ domains.php # Domain listing
71
+ β”œβ”€β”€ project_*.php # Project management files
72
+ β”œβ”€β”€ admin.php # Admin panel
73
+ β”œβ”€β”€ css/ # Stylesheets
74
+ β”œβ”€β”€ js/ # JavaScript files
75
+ β”œβ”€β”€ includes/ # PHP includes
76
+ └── ajax/ # AJAX handlers
77
+ ```
78
+
79
+ ## Security Considerations
80
+
81
+ - All user inputs are sanitized
82
+ - Passwords are hashed using secure methods
83
+ - Session management is implemented
84
+ - Access control is enforced based on user roles
85
+
86
+ ## Contributing
87
+
88
+ 1. Fork the repository
89
+ 2. Create a feature branch
90
+ 3. Commit your changes
91
+ 4. Push to the branch
92
+ 5. Create a Pull Request
93
+
94
+ ## License
95
+
96
+ This project is licensed under the MIT License - see the LICENSE file for details.
97
+
98
+ # Domain Management System
99
+
100
+ A web-based platform to explore, search, and view projects across various domains, based on the DMS database.
101
+
102
+ ## Features
103
+
104
+ - **Browse Domains**: View all available domains in the system and their associated projects.
105
+ - **Project Search**: Search for projects by name, description, domain, or type (Hardware/Software).
106
+ - **Project Details**: View detailed information about each project, including descriptions, contact information, and associated resources.
107
+ - **Student Information**: If the student table exists, search and view student information related to projects.
108
+ - **Dynamic Data Fetching**: The system automatically fetches data from parent tables, avoiding manual duplication of data.
109
+ - **Domain Descriptions**: Domain descriptions are automatically generated from the database or fallback to defaults.
110
+
111
+ ## Setup Instructions
112
+
113
+ ### Prerequisites
114
+
115
+ - Web server with PHP support (e.g., Apache, Nginx)
116
+ - MySQL/MariaDB database server
117
+ - PHP 7.0 or higher
118
+
119
+ ### Database Setup
120
+
121
+ 1. Create a new database named `dms` in your MySQL server:
122
+ ```sql
123
+ CREATE DATABASE dms;
124
+ ```
125
+
126
+ 2. Import the SQL file (`dms (2).sql`) into your database:
127
+ - Using phpMyAdmin: Go to the Import tab, select the SQL file, and click "Go"
128
+ - Using MySQL command line:
129
+ ```
130
+ mysql -u username -p dms < "dms (2).sql"
131
+ ```
132
+
133
+ 3. (Optional) Create domain descriptions table:
134
+ - Access the `create_domain_descriptions.php` script in your browser to create and populate the domain_descriptions table
135
+ - This step is optional but recommended for better organization of domain metadata
136
+
137
+ ### Web Application Setup
138
+
139
+ 1. Copy all files to your web server's document root (or a subdirectory).
140
+ 2. Update the database connection details in `includes/db_connect.php` if needed.
141
+ 3. Make sure your web server has permissions to read/write to the files.
142
+ 4. Access the website through your web browser.
143
+
144
+ ## Database Structure
145
+
146
+ The database consists of multiple tables:
147
+
148
+ - `domain_1` through `domain_12`: Tables containing projects from different domains
149
+ - `students_info`: Table containing student information (if available)
150
+ - `domain_descriptions`: Optional table for storing domain descriptions
151
+
152
+ Each domain table has a similar structure with fields like:
153
+ - `Domain_ID`
154
+ - `Project_ID`
155
+ - `Project_Name`/`Project _Name`
156
+ - `Email`
157
+ - `H/S` (Hardware/Software)
158
+ - `Description`
159
+ - `Links`
160
+
161
+ ## Dynamic Data Handling
162
+
163
+ The system uses several utility functions to automatically fetch and process data:
164
+
165
+ - **Domain Descriptions**: Automatically fetched from the domain_descriptions table if it exists, otherwise falls back to default values
166
+ - **Project Names**: The system handles different column naming conventions across tables
167
+ - **Cross-Domain Search**: Searches can be performed across all domain tables simultaneously
168
+ - **Student-Project Association**: Student data is linked dynamically to projects for comprehensive viewing
169
+
170
+ ## Usage
171
+
172
+ 1. **Home Page**: View basic statistics and recent projects from all domains
173
+ 2. **Domains Page**: Browse all domains and access their projects
174
+ 3. **Projects Page**: Search for projects across all domains with advanced filtering
175
+ 4. **Students Page**: Search for students by name, division, or domain (if the table exists)
176
+
177
+ ## Troubleshooting
178
+
179
+ - If you encounter database connection errors, verify that the credentials in `includes/db_connect.php` are correct.
180
+ - Make sure that the `dms` database has been properly imported with all required tables.
181
+ - Check your PHP error logs if you're experiencing issues with the website.
182
+
183
+ ## Credits
184
+
185
  Created as a Database Management System project.