Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yonson2/mla
Magic League Administrator - Easily run and manage a Magic: The Gathering monthly league
https://github.com/yonson2/mla
Last synced: about 2 months ago
JSON representation
Magic League Administrator - Easily run and manage a Magic: The Gathering monthly league
- Host: GitHub
- URL: https://github.com/yonson2/mla
- Owner: yonson2
- License: gpl-3.0
- Created: 2017-09-17T08:17:41.000Z (about 7 years ago)
- Default Branch: dev
- Last Pushed: 2017-09-20T17:21:24.000Z (about 7 years ago)
- Last Synced: 2024-05-08T13:33:35.635Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magic League Administrator*
Magic League administrator, _MLA_ for short, is a tool designed to provide an easier and more comfortable way of creating and managing a Magic: The Gathering [League](https://magic.wizards.com/en/event-types/magic-league).
## Table of Contents
- [Install](#install)
- [Configuration](#configuration)
* [Environment-Variables](#environment-variables)
* [Database](#database)
* [MLA Settings](#mla-settings)
- [Usage](#usage)
- [API](#api)
## Install
Clone this repository:
```sh
git clone [email protected]:yonson2/mla.git
```
Install with [npm](https://www.npmjs.com/):
```sh
npm install
```
## Configuration
### Environment variables
MLA needs the following enviroment variables to be set:
**TODO**
### Database
**TODO**
### MLA Settings
**TODO**
## Usage
Please head over to the configuration section first and make sure MLA is properly configured because otherwise you won't be able to start it.
Start the API:
```sh
npm start
```
The server is now listening on port *3456* (unless specified otherwise in the [configuration](#mla-settings) and ready to be used!
## API
MLA follows the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)
You can check out its full documentation here **TODO**
\**Temporary name*