/SchoolBoard

Digital Signage WebApp which shows current information about missing classes and other events at the school.

Primary LanguageC#

SchoolBoard 🖥️

⚠ This project will not be further developed or maintained! ⚠

Digital Signage WebApp which shows current information about missing classes and other events at the school. If you want to use something like this, feel free to fork it and make your own version to suit your needs.

Build and Develop 🧪

The WebApp is written in C# and is dotnet core based so make sure you have the .NET Core SDK installed. You can get it here.

Terminal

  1. Open your favourite terminal.
  2. Clone the repo and navigate into the projects root folder.
  3. Run dotnet run --project WebApp/SchoolBoard/SchoolBoard.csproj.
  4. The project should now get compiled and will run on a local server at localhost:5000.

Visual Studio

The project was created using Visual Studio 2019 Community so all tutorials and instructions are based on on VS 2019 and might vary for older versions.

  1. Clone the repo using your favourite client (like GitHub Desktop or Git for Windows).
  2. Open Visual Studio and click on Open a project or solution.
  3. Naviagte to the repo and select the SchoolBoard.sln solution file inside the WebApp folder and wait for it to load.
  4. Click on the button with the green run icon which should say IIS Express.

Configuration ⚙

Web Interface

The web interface is currently disabled and might be added later down the line.

Configuration file

  1. Open the project folder WebApp/SchoolBoard/.
  2. Edit the appsettings.json file in any text editor. Make sure to use the correct formatting. The app might crash if you store non-valid json code in there.
  3. Save and just refresh the page (or wait 5 minutes and let the auto refresh to it's thing). All settings can be updated during runtime and do not require a restart.

How to configure the appsettings.json file.

If you are starting the compiled project from the command line using dotnet ./SchoolBoard.dll, your appsettings.json file is located in \WebApp\SchoolBoard\bin\Debug\netcoreapp3.1 or \WebApp\SchoolBoard\bin\Release\netcoreapp3.1, depending on your build configuration.

Btw: Since the configuration is managed by ASP.NET Core, you can use the JSON configuration provider for different production and development coonfigurations by creating a new appsettings.Environment.json file (e.g. appsettings.Development.json) and put in the configuration changes. You can also use environmental variables for the config which override appsettings.json.

Personal Usage 🧩

Feel free to build something yourself upon this project to suit your needs.