This repository contains the source code for Folium, you can can find more about Folium at http://folium.education/.
Folium.Ui is a Single Page Application (SPA) which uses a lightweight ASP.NET core MVC web app to bootstrap an Angular based client app written in Typescript. The Folium.Ui client app calls directly onto Folium.Api, a Web API built using ASP.NET Core MVC. Folium.Api implements an Event Sourcing pattern using EventSaucing to store an event stream of aggregate changes. The app is secured using IdentityServer.
To create a build of the Folium app you will need to follow the following steps:
Currently the Folium.Api must be run on a Windows OS (min Windows 7 SP1), as there is it a dependency on the full .NET Framework stack (via EventSaucing), however Folium.Ui is cross platform.
- Ensure you have .NET Core SDK installed https://www.microsoft.com/net/core
- Have Node.js installed https://nodejs.org/en/download/
- Make sure you have gulp installed globally
npm install -g gulp-cli - Once you have cloned the repo, navigate to Folium.Ui project directory and run
npm install
To create a build, navigate to the Folium.Api folder and run dotnet restore to restore the nuget packages, then run dotnet publish -c Release. Navigate to the Folium.Ui folder and run gulp publish; dotnet publish -c Release.
To deploy the app, first complete the build steps above and then complete the following:
You need to host the app on a Windows Server (min Windows Server 2008 R2 SP1), we recommend using IIS.
- Follow this guide to install ASP.NET Core on Windows with IIS.
- You will need a SQL Server instance (min SQL Server 2012), SQL Server Express will do fine
- Run all the scripts in the SQL-Scripts folder
- Install and configure IdentityServer
We found identityserver app pool must have 'Load User Profile' in Advanced Settings and the identity needs permissions to read its private key via mmc snap in -> All Tasks -> Manage Private Keys.
- Copy the Folium.Api and Folium.Ui build outputs (publish folders) into two seperate web applications
- You need to set your appsettings, copy the appsettings.template.json in both projects and paste as appsettings.json, update the template with the correct settings for your environment
- Install a Skill set (see below)
You will need to install at least one Skill Set to use the app, here's how
Slim Image Cropper is a 3rd party library that is used to edit and updoad users' profile pics, it is not a requirement, but does dramatically improve the user experience. However, the use of the library does requires you to purchase a license.
Once a license is purchased you can overwrite the contents of Folium.Ui/lib/slim with the corresponding javascript and css from the library.
In our setup we have developed some small integration tasks that sync the students, placements and tutor groups from our student records system into Folium. The Folium.Api exposes a number of end points which allow for these placements to be sync'd, we then modify the User and Tutee tables directly (this should also be accomplished via the api in the future). If you would like further info then please get in touch. We recommend using Hangfire to schedule and run your tasks.
If you would like to get involved and develop and contribute to the project, then great, we welcome pull requests :) Some points to help you get setup and running, please shout if we have forgot anything!
Currently the Folium.Api must be run on a Windows OS (min Windows 7 SP1), as there is it a dependency on the full .NET Framework stack (via EventSaucing), however Folium.Ui is cross platform.
- Following the Build steps above locally
- Our prefered development environment is Visual Studio Code
- In the Folium.Ui project there are a number of predefined Visual Studio tasks which in run the various gulp tasks, or you can run them directly from the command line.
- There is a gulp watch task which will automatically transpile the typescript, sass files and sync the files to the wwwroot folder. You should run this task in the background whilst developing Folium.Ui, there is also a watch.bat and watch.command which can be run directly from the relevant OS.
Folium has been built with the help of these superb librarys