https://github.com/davwheat/flarum-badge-api

https://github.com/davwheat/flarum-badge-api

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/davwheat/flarum-badge-api
• Owner: davwheat
• Created: 2021-03-24T21:24:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-22T13:02:45.000Z (over 1 year ago)
• Last Synced: 2024-05-01T16:41:14.533Z (7 months ago)
• Language: TypeScript
• Size: 2.13 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Flarum Badge API

This is a super simple API that can create badges for your Flarum extensions READMEs.

This is hosted on my home internet on a Raspberry Pi, so 100% uptime is not guaranteed (though it should come pretty close!).

## Suggestions

If you want to suggest a new badge, open an issue and explain *clearly* what the badge could contain/show.

## Using the badges

The documentation in this README is not exhaustive. Please read the documentation found below for all possible badges, options, and information.

[Read the full documentation](https://flarum-badge-api.davwheat.dev/v1)

### Compatible with latest Flarum

This badge shows whether your extension is compatible with the latest version of Flarum.

Make a call to `https://flarum-badge-api.davwheat.dev/v1/compat-latest/` (replacing `` with your extension's package name).

Example badge for `FoF/Formatting`:

![](https://flarum-badge-api.davwheat.dev/v1/compat-latest/fof/formatting)

## Installing and running

Normal people don't need to do this. This is for development purposes only.

1. Create a `.env` file:

```

# .env

EXTIVERSE_TOKEN=

BASE_URL=

PORT=

```

2. Install deps && start the Express server:

```sh

yarn

# In one terminal...

yarn dev

# In another terminal...

yarn start

```

### Running permanently on a server

```sh

npm i -g pm2

yarn build

yarn pm2:watch

```