Skip to content

Woundrite/CAPE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 

Repository files navigation

CAPE

CAPE is a robust online examination management platform that streamlines the administration of exams, student information, and study materials. Designed for educational institutions, CAPE offers intuitive dashboards and essential features to support seamless exam organization and management.


Table of Contents

  • Introduction
  • Table of Contents
  • Prerequisites
  • Installation
  • Getting Started
  • Usage
  • Contributing
  • License

Prerequisites

Before you begin, ensure your system meets the following requirements:

  • Python 3.8 or higher
  • Node.js and npm (for frontend setup)
  • MongoDB (for data storage)
  • Required Python packages (install them using pip):
    • Django
    • djangorestframework
    • pandas
  • Required JavaScript packages:
    • react
    • chart.js
    • react-chartjs-2

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/cape.git
    cd cape
  2. Set up a virtual environment (optional but recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  3. Install required Python packages:

    pip install -r requirements.txt
  4. Install frontend packages:

    cd frontend
    npm install
  5. Configure database settings in the backend settings file.

  6. Set up MongoDB and any other necessary configurations as per the project requirements.


Getting Started

Follow these steps to initialize CAPE:

  1. Activate your virtual environment and start the backend server:

    python manage.py runserver
  2. Navigate to the frontend directory and start the frontend:

    cd frontend
    npm start
  3. Access the dashboard in your browser at http://localhost:3000.


Usage

CAPE provides a user-friendly dashboard for managing examination details:

  • Exam Statistics: View detailed analytics on exams, results, and trends.
  • Student Information: Manage student profiles, attendance, and exam schedules.
  • Study Materials: Add or update study resources by subject.

To use the platform:

  1. Log in with your admin credentials.
  2. Navigate to various sections via the dashboard to manage exams and student information.

Contributing

Interested in contributing to CAPE? Here’s how:

  1. Fork this repository.
  2. Create a new branch for your feature or bug fix.
  3. Implement your changes and run tests.
  4. Submit a pull request with a description of your modifications.

All contributions are welcome and appreciated!


License

This project is licensed under the MIT License.

For further information on setting up CAPE or contributing, refer to the documentation or contact the project maintainers.

Happy coding with CAPE! 🎓

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •