aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 440b40232fa7e398b0ffc5052a0cc00e93948538 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# ferdi-server
Unofficial Franz server replacement for use with the Ferdi Client.

## Features
- [x] User registration
- [ ] User login (not yet functional)
- [x] Service creation, download and listing
- [ ] Service removing
- [ ] Functioning service store

## Setup
1. Clone this repository
2. Install the [AdonisJS CLI](https://adonisjs.com/)
3. Run the database migrations with
    ```js
    adonis migration:run
    ```
4. Start the server with
    ```js
    adonis serve --dev
    ```

## License
ferdi-server is licensed under the MIT License