Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khaledashrafh/students-statistics-system
It's a subsystem that provides statistics related to student registration. It includes two functionalities: displaying registration statistics and listing batch files.
https://github.com/khaledashrafh/students-statistics-system
ci-cd cicd cloud-computing cloud-computing-course component continous-deployment continous-integration docker docker-compose docker-container docker-image dockerfile dockerhub github-actions githubactions students-statistics students-statistics-system subsystem
Last synced: 21 days ago
JSON representation
It's a subsystem that provides statistics related to student registration. It includes two functionalities: displaying registration statistics and listing batch files.
- Host: GitHub
- URL: https://github.com/khaledashrafh/students-statistics-system
- Owner: KhaledAshrafH
- License: mit
- Created: 2023-05-20T23:36:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-03T10:43:50.000Z (25 days ago)
- Last Synced: 2024-12-03T11:34:21.193Z (25 days ago)
- Topics: ci-cd, cicd, cloud-computing, cloud-computing-course, component, continous-deployment, continous-integration, docker, docker-compose, docker-container, docker-image, dockerfile, dockerhub, github-actions, githubactions, students-statistics, students-statistics-system, subsystem
- Language: Java
- Homepage:
- Size: 757 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Student Statistics System
It's a subsystem that provides statistics related to student registration. It includes two functionalities: displaying registration statistics and listing batch files.
## Displaying Registration Statistics
The system allows users to view various statistics related to student registration. The following statistics should be shown:
- Number of users: 2
- Number of students registered in AI course: 2
- Number of students registered in Math course: 1
- Number of students registered in Prog course: 1
### Assumptions
- Two students are registered with the following data:
- Ahmed, 1, Math, AI
- Mohamed, 2, AI, Prog
## Listing Batch Files
The system enables users to list all batch files located under the specified path. The following flow describes this functionality:
### Assumptions
- The path `/app/data/batch/` is correctly mounted to a specific folder.
- The files in this folder are:
- 1_verified.csv
- 2.csv
- 3_verified.csv
- 4.csv
1. Run the component.
2. The system should display the following information:
- Number of users: 2
- Number of students registered in AI course: 2
- Number of students registered in Math course: 1
- Number of students registered in Prog course: 1
- Number of batch files: 4
- Number of verified batch files: 2
### Assumptions
- The assumptions mentioned in the [first component requirements](https://github.com/KhaledAshrafH/Students-Registration-System) are also valid for this functionality.
## CI/CD Pipeline
To ensure the successful building and deployment of the relevant components, a CI/CD pipeline is implemented for the software. The pipeline consists of continuous integration (CI) and continuous deployment (CD) processes for each repository.
### CI Process
The CI process ensures that each repository's component is built successfully. It involves the following steps:
1. Set up a CI configuration in the repository to trigger a build process on each commit.
2. Configure the build process to compile the source code and run any necessary tests.
3. If the build process succeeds, proceed to the CD process.
### CD Process
The CD process pushes the image for the relevant component to Docker Hub. It includes the following steps:
1. Set up a CD configuration in the repository to trigger the deployment process upon a successful build.
2. Build a Docker image for the component, using the provided Dockerfile.
3. Tag the image with the appropriate version, such as `latest`.
4. Push the image to Docker Hub, using the specified repository and version.
## Docker Compose Configuration
The provided Docker Compose file allows for the deployment of the subsystem components. It defines two services: `student-statistics-process` and `registration-process`.
### `student-statistics-process`
- Builds the image from the source code.
- Maps the local folder `/app/data/batch` to the corresponding folder in the Docker container.
- Exposes port `80` for accessing the component.
### `registration-process`
- Builds the image from the source code.
- Maps the local folder `/app/data/batch` to the corresponding folder in the Docker container.
- Exposes port `81` for accessing the component.
## Running the Docker Compose File
To run the Docker Compose file and deploy the subsystem, follow these steps:
1. Download the Docker Compose file from the repository.
2. Update the file with the appropriate local paths as indicated.
3. Open a terminal or PowerShell in the directory where the Docker Compose file is located.
4. Run the following command to start the containers:
```
docker-compose up -d
```
5. Open another terminal to execute the other component if needed.
6. To execute commands inside a container, run the following command in the terminal:
```
docker exec -it component-name bash
```
7. Run the component's main class or entry point inside the container. For example, for the main class `Main`:
```
java Main
```
By following these steps, you can deploy and utilize the Student Registration Subsystem, incorporating CI/CD practices and Docker containerization concepts.
## Contributing
Contributions to the system are welcome. If you would like to contribute, please follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes in your branch.
4. Test your changes thoroughly.
5. Submit a pull request to the main repository.
6. Provide a clear description of your changes and the problem they solve.
7. Be responsive to any feedback or questions regarding your pull request.
## Team
This System was created by a team of four computer science students at Faculty of Computers and Artificial Intelligence Cairo University. The team members are:
- [Khaled Ashraf Hanafy Mahmoud - 20190186](https://github.com/KhaledAshrafH).
- [Kareem Galal Zaki Sayed - 20190383](https://github.com/kareemgalall).
- [Samah Moustafa Hussien Mahmoud - 20190248](https://github.com/Samah-20190248).
- [Ayatullah Esam El-din Mohamed - 20190123](https://github.com/oshaesam1).
## Acknowledgment
- This System is based on Cloud Computing course at Faculty of Computers and Artificial Intelligence Cairo University. We would like to thank prof. Fatma Omara for his guidance and support throughout this course.
- [The Another Subsystem](https://github.com/KhaledAshrafH/Students-Registration-System)
## License
The System is released under the [MIT License](LICENSE.md). You are free to use, modify, and distribute the toolbox in accordance with the terms of this license.