Skip to content

jerrygoguen/doctrina-lrs

 
 

Repository files navigation

Build Status

Getting Started

Use these instructions to get the project up and running.

Prerequisites

You will need the following tools:

Setup

Follow these steps to get your development environment set up:

  1. Clone the repository
  2. Initialize submodule in the local configuration
    git submodule init
    
  3. Fetch all data for each submodule
    git submodule update
    

Next pick your development tool

Command line/VS Code (RECOMMENDED)

Follow these steps to get your development environment set up:

  1. Within the .\src\ directory, restore required packages by running:

    dotnet restore .\Doctrina.sln
    
  2. Next, build the solution by running:

    dotnet build .\Doctrina.sln --no-restore
    
  3. Next, within the .\src\Doctrina.WebUI\ start the server by running:

     dotnet run
    
  4. Launch http://localhost:5000/ in your browser to view the React SPA

  5. Launch https://localhost:5001/xapi/about in your browser to view the xAPI about resource

Visual Studio

Follow these steps to get your development environment set up:

  1. Open the Doctrina.sln inside the src folder.

  2. Hit F5 or CTRL+F5 to start from WebUI.csproj

  3. Launch https://localhost:44393/ to see Blazor application.

  4. Launch https://localhost:44393/xapi/about in your browser to view the xAPI about resource

  5. Try posting a statem

Testing

After following the steps for setup, do the following to run the lrs-conformance-test-suite

  1. Within the .\lrs-conformance-test-suite run the following:
    npm install
    

1.1 If installation fails, do the following:

npm update

1.2

npm audit fix
  1. After npm packages have been installed, run the following:
    node bin/console_runner.js -e http://localhost:52209/xapi -a -u admin@example.com -p zKR4gkYNHP5tvH --errors
    or
    node bin/console_runner.js -e http://localhost:5000/xapi -a -u admin@example.com -p zKR4gkYNHP5tvH --errors
    
    IMPORTANT: running tests on https does not work, hence the http schema above.

Technologies

  • .NET Core 3.0
  • Entity Framework Core 3.0
  • Blazor.net
  • Redis

License

This project is licensed under the AGPLv3 License - see the LICENSE file for details.

About

Self-hosted Learning Record Store using ASP.net Core (xAPI LRS)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 98.2%
  • HTML 1.2%
  • Other 0.6%