Skip to content
This repository has been archived by the owner. It is now read-only.
πŸ—œ Slim server wrapper for Franz API to add custom recipes
JavaScript CSS
Branch: master
Clone or download
Latest commit 684af0b Sep 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Initial commit Sep 14, 2019
config
database Initial commit Sep 14, 2019
public Initial commit Sep 14, 2019
recipes Ignoring recipe files Sep 14, 2019
resources/views Initial commit Sep 14, 2019
start Initial commit Sep 14, 2019
.editorconfig Initial commit Sep 14, 2019
.env.example Initial commit Sep 14, 2019
.gitattributes Initial commit Sep 14, 2019
.gitignore
LICENSE
README.md Initial commit Sep 14, 2019
ace Initial commit Sep 14, 2019
package.json Initial commit Sep 14, 2019
server.js

README.md

ferdi-slim-server

ferdi-slim-server is a slim alternative to ferdi-server.

Opposed to ferdi-server, ferdi-slim-server is only a wrapper around the Franz API that allows you to add custom recipes. These recipes will be availible on all clients that conntect to your ferdi-slim-server.

Looking for a full Ferdi server?

If you want to create an independent Ferdi server, please use ferdi-server instead of ferdi-slim-server.

Installation

  1. Clone this repository
  2. Install the AdonisJS CLI
  3. Copy .env.example to .env and edit the configuration to your needs
  4. Run the database migrations with
    adonis migration:run
  5. Start the server with
    adonis serve --dev

Configuration

franz-server's configuration is saved inside the .env file. Besides AdonisJS's settings, ferdi-server has the following custom settings:

Usage

Creating admin users

Before recipes in ferdi-slim-server get published to all clients, an admin user has to verify the recipe first.

To create a new admin user, visit /admin/register. Please keep in mind that the "Registration Key" is defined in your .env file.

Creating a new recipe

For documentation on how to create a recipe, please visit the official guide by Franz.

When creating a new recipe in ferdi-slim-server you'll have two options:

Upload a recipe directly

To upload a recipe directly, go to /new. Fill in all information and submit the form. The recipe can now be verified using an admin account.

Import your recipe from a GitHub repository

To import a GitHub repository, go to /github. Fill in all information and submit the form. The recipe can now be verified using an admin account.

More information on recipe creation can be found in the ferdi-server repository.

Verifying recipes

After uploading a recipe, an admin user has to verify it.

To verify a recipe, log in to your admin account on /admin/login and visit the admin dashboard at /admin/dashboard. You will see a list of unverified recipes that you can verify by downloading them, then publishing them by clicking Accept.

License

ferdi-slim-server is licensed under the MIT License

You can’t perform that action at this time.