OME Portal

"OME" means "Online Marathon Eventers", it is speedrun online event moderation group.

This is used for management/moderation our event.

Requirements

• php > 7.4
• composer
• npm

Installation

Install PHP dependencies with Composer.

composer install

Install JavaScript Dependencies with npm.

npm install

And build assets with parcel.

npm run dev

Make .env in root from .env.example in repository.

then, generate application key for Laravel framework.

php artisan key:generate

Run application

Below command run application with artisan.

php artisan serve

Setup Swagger Mock

This application has api document written as Swagger/OpenAPI yaml.

And you can setup mock server with swagger-codegen. This requires java (maybe jre > 9 but not tested yet).

First, run script for download swagger-codegen jar file.

npm run docs:setup

then generate mock server (node-js server)

npm run mock-server:generate

Finally you can run mock server.

npm run mock-server

# Access to mock server with localhost:8080
# and view UI with http://localhost:8080/docs