Exam Time Manager

Efficiently manages classroom time, exams, and study details on screens.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The Exam Time Management App is a powerful tool designed to streamline the management of exam timings and classroom schedules. It is specifically developed to display exam timings and study details on large screens, providing a comprehensive solution for educational institutions.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

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

1. Install Node.js LTS:

   • Download Node.js version 20.10.0 from the official website: NODEJS Downloads

   (LINUX) Install Node.js:

   • On Ubuntu 22.04, use the following command:

     sudo apt install nodejs

2. Install Git:

   • Download and install Git from the official website: Git Downloads

3. Install Visual Studio Code:

   • Install the Visual Studio Code redistributables. You can find them on the Microsoft website or use the following links:
     • Visual Studio Code

Installation

1. Clone the repository:

   git clone https://github.com/awell00/exam_time_manager.git

2. Navigate to the backend and frontend folders:

   cd backend

   cd frontend

3. Install npm or pnpm packages: For Backend:

   npm install

   or

   pnpm install

4. Run the frontend with Vite and also backend:

   npm run dev

   or

   pnpm dev

5. Build the project: For Backend and backend:

   npm run build

   or

   pnpm build

6. Run with Docker:

   • Build Docker image:

     docker build -t exam_time_manager .

   • Run Docker container:

     docker run -p 4000:4000 -d exam_time_manager

(back to top)

Usage

EXAM TIME MANAGER

1. Choose the desired examination room.
2. Indicate the new subject by providing its name, duration, and the commencement time along with the class number.
3. Initiate the exam by selecting the "add" button.
4. Conclude the exam by clicking on the "stop" button when finished.

(back to top)

Roadmap

Resolve Issue

• Enhance mobile user interfaces across all components.
• Incorporate features related to classroom creation and exam addition processes.
• Enhance both design and code elements for overall improvement.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache v2 License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @AwellTv - awellpro@gmail.com

(back to top)

Acknowledgments

(back to top)