Skip to content

DanielRajChristeen/StudentHub

Repository files navigation

StudentHub

StudentHub is a platform designed to streamline the management of student information, offering a simple and intuitive interface for administrators and students. This project is fully customizable and provides tools for secure data handling and easy deployment.


Features

  • User Authentication: Secure login and registration system.
  • Student Information Management: Add, update, delete, and view student details.
  • Responsive Design: Ensures a seamless user experience across devices.
  • Customizable: Replace credentials and values for personal use.
  • Open Source: Modify and enhance as per your requirements.

Screenshots

  1. Login Page

    Login Page

  2. Dashboard

    Dashboard

  3. Student Window

    Manage Students


Installation Instructions

Follow these steps to set up and customize StudentHub for personal use.

Prerequisites

  • Python 3.8+
  • Git
  • A database system (e.g., MySQL, SQLite)
  • Any compatible code editor (e.g., VS Code)

Setup

  1. Clone the Repository

    git clone https://github.com/DanielRajChristeen/StudentHub.git
    cd StudentHub
  2. Install Dependencies Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate

    Install required Python packages:

    pip install -r requirements.txt
  3. Set Up the Database

    • Modify the database settings in the settings.py file:
      DATABASES = {
          'default': {
              'ENGINE': 'django.db.backends.sqlite3',  # Or 'django.db.backends.mysql'
              'NAME': 'your_database_name',
              'USER': 'your_database_user',  # If using MySQL
              'PASSWORD': 'your_database_password',  # If using MySQL
              'HOST': 'localhost',  # Database host
              'PORT': '3306',  # Default MySQL port
          }
      }
    • Run migrations:
      python manage.py makemigrations
      python manage.py migrate
  4. Customize Credentials Replace placeholders like admin credentials or API keys in the codebase:

    • Locate files with sensitive details (e.g., .env or settings files).
    • Update values with your own.
  5. Start the Server

    python manage.py runserver

    Visit http://127.0.0.1:8000/ to access StudentHub.


Usage

Admin Access

  1. Create a superuser for admin access:
    python manage.py createsuperuser
  2. Log in to the admin panel at http://127.0.0.1:8000/admin.

Adding Features

  • Modify the views and templates to add custom functionalities.
  • Add plugins or integrate APIs as needed.

Contributing

We welcome contributions! Follow these steps to contribute:

  1. Fork the repository.
  2. Create a feature branch:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add new feature"
  4. Push to your fork and create a pull request.

License

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

About

StudentHub is a comprehensive student management system designed to streamline administrative tasks and enhance academic processes. This project is aimed at educational institutions, administrators, and developers looking for a robust, modular, and scalable platform to manage student information, assignments, attendance, and more.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors