Ergogenesis

Table of Contents

• Introduction
• Features
• Tech Stack
• Installation
• Usage
• Project Structure
• Database Structure
• Screenshots
• Contributing
• License
• Contact

Introduction

Ergogenesis is a comprehensive platform designed to facilitate students in uploading their documents, projects, and patents. Faculty members can then review these submissions and take appropriate actions, such as forwarding them to organizations, filing patents, or submitting publications to official sites like IEEE.

Features

• Student Dashboard: Separate dashboard for students to manage their submissions.
• Faculty Dashboard: Separate dashboard for faculty to review and manage submissions.
• Document Management: Upload and manage projects, patents, and publications.
• User Authentication: Secure login and signup with OTP verification.
• Alumni Display: Showcase alumni and their achievements.
• Theme Customization: Update and personalize themes.
• Responsive UI: User-friendly interface with modern design.
• Password Management: Options to reset and forget passwords.
• Email Notifications: Send OTPs and other notifications via email.

Images

Tech Stack

• Frontend: HTML, CSS, JavaScript
• Backend: PHP
• Database: MySQL (via XAMPP)
• Email Service: PHP Mailer or similar service for sending OTPs
• Server Environment: XAMPP

Installation

Prerequisites

• XAMPP installed on your local machine
• A web browser (Chrome, Firefox, etc.)

Steps

1. Clone the repository:

   git clone https://github.com/your-username/ergogenesis.git

2. Navigate to the project directory:

   cd ergogenesis

3. Move project files to XAMPP directory: Copy the project folder to the htdocs directory of your XAMPP installation.

4. Start XAMPP: Open the XAMPP control panel and start Apache and MySQL.

5. Import the database:

   • Open phpMyAdmin.
   • Create a new database named ergogenesis.
   • Import the provided SQL file into the ergogenesis database.

6. Configure the environment: Update the database connection settings in the config.php file.

7. Run the application: Open a web browser and navigate to http://localhost/ergogenesis.

Usage

1. Student:

   • Register and log in to access the student dashboard.
   • Upload documents, projects, patents, and publications.
   • View and manage your submissions.

2. Faculty:

   • Log in to access the faculty dashboard.
   • Review student submissions.
   • Forward submissions to organizations, file patents, or submit to publications.

Project Structure

ergogenesis/
├── assets/
│   ├── css/
│   ├── js/
│   └── images/
├── config/
│   └── config.php
├── public/
│   ├── index.php
│   ├── login.php
│   ├── signup.php
│   └── dashboard/
│       ├── student.php
│       └── faculty.php
├── src/
│   ├── controllers/
│   ├── models/
│   └── views/
└── README.md

Database Structure

Contributing

We welcome contributions from the community! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

• Project Maintainer: NITIN PRAJWAL R
• Email: nitinprajwalr@gmail.com
• GitHub: /nitinprajwal