emgrav / keymaker

A Matrix Server List

Keymaker

Keymaker is a Mastodon Community Finder based Matrix Community serverlist page Server.
View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Built With

• Rust
• Actix-web
• Askama
• Matrix

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Rust

Get it from https://rustup.rs/

• Postgresql

apt install postgresql

Or the system specific packagemanger

Installation

1. Clone the repo

git clone https://github.com/daydream-mx/keymaker.git

2. Setup .env file

Move .env.example t .env and change the fields according to your setup.

Usage

To run it you can simply run cargo run inside of the cloned folder.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the AGPLv3 License. See LICENSE for more information.

Contact

MTRNord - @mtrnord:nordgedanken.dev

Project Matrix Room: #serverlist:nordgedanken.dev