Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
89 lines (62 loc) · 7.14 KB

README.md

File metadata and controls

89 lines (62 loc) · 7.14 KB
Raw

eSchool - Microservice and Containers based open source School Administration Software

Linux Build Status for 'main' branch

Image Status Image Status
Enrolling.API Enrolling.API ESchool.GraphQL ESchool.GraphQL
CertificateProcessing.API CertificateProcessing.API Frontend.Blazor Frontend.Blazor
WebStatus WebStatus CodeQL CodeQL
ExamManagement.API ExamManagement.API LibraryManagement.API LibraryManagement.API
ResultProcessing.API ResultProcessing.API

System requirements

Recommended Hardware requirements for Windows

  • Windows 10 Pro, Education or Enterprise
  • 64-bit Processor with Second Level Address Translation (SLAT)
  • CPU support for VM Monitor Mode Extension (VT-c on Intel CPU's)
  • Virtualization must enabled in BIOS. Typically, virtualization is enabled by default
    • This is different from having Hyper-V enabled

Software requirements for Windows

  • Docker Community Edition (aka. Docker for Windows) - Requires Windows 10 Pro 64 bits and Hyper-V enabled
  • Latest .NET 5.0 SDK from: https://www.microsoft.com/net/download
  • (Optional) Visual Studio 2019
  • (Optional) Visual Studio Code

NOTE: If you can install Docker Desktop for Windows following the instruction in https://docs.docker.com/docker-for-windows/install/, then you are good to go.

How to Run

After installing Docker in your machine, just run

$ docker-compose up

in terminal from project's root folder. The first run can take 30 mins to 1 hour depending on your internet speed, as it will download required docker images from the docker hub. After everything starts up, you can access the Enrolling.API swagger UI by visiting http://localhost:5102/swagger/

How to Run on Visual studio

  • Open eSchool project on Visual studio then right click on docker-compose project. docker-compose-up
  • From the menu select Set as Startup Project.
  • Now, run the project by clicking docker-compose from the main status menu bar.

Note: You have to run Docker desktop before running eSchool project on visual studio

Service URLs

Tech & Tools

  • .NET Core
  • Docker
  • Orchestrators: Kubernetes
  • Visual Studio
  • SQL Server
  • Azure DevOps
  • RabbitMQ
  • API Gateway
  • GraphQL
  • Blazor

Contributing

Everyone is welcome to contribute, whether it's in the form of code, documentation, bug reports, feature requests, or anything else. See the Contributing guide for more details.

Sending feedback and pull requests

As mentioned, we'd appreciate your feedback, improvements and ideas. You can create new issues at the issues section, do pull requests and/or send emails to [email protected]

Thanks to all the people and bot (😉) who have contributed

contributors

License

Code licensed under the MIT License.