https://github.com/relay-md/relay.md

Open Source version of relay.md
https://github.com/relay-md/relay.md

obsidian-md obsidian-plugins saas

Last synced: 22 days ago
JSON representation

Open Source version of relay.md

• Host: GitHub
• URL: https://github.com/relay-md/relay.md
• Owner: relay-md
• License: other
• Created: 2024-05-18T08:31:57.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-19T15:02:47.000Z (6 months ago)
• Last Synced: 2024-09-30T09:40:51.381Z (about 1 month ago)
• Topics: obsidian-md, obsidian-plugins, saas
• Language: Python
• Homepage: https://relay.md
• Size: 6.37 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


relay.md




  

    

  



Relay.md enables multiplayer [obsidian](https://obsidian.md), a note taking software for your personal knowledge base that does not come with any means to communicate notes.

The software in this repository represents the backend and website that offers an API and user interface. Integration with Obsidian itself requires the installation of [the relay.md plugin](https://github.com/relay-md/relay-md-obsidian-plugin).

# Getting Started

The software is configured in a way that allows deploying as microservices. The required services are:

 * `web`: This service provides the website where people can register, login and manage teams and topics

 * `api`: This service provides the application programming interface to the obsidian plugin and allows for posting, editing and deleting of notes and embeds.

You can start your local development environment using docker-compose:

    docker-compose up

# Contributing

If you encounter a bug, please file an [issue](https://github.com/relay-md/relay.md/issues) to let us know. Alternatively, please feel free to contribute a bug fix directly. If you are planning to contribute changes that involve significant design choices, please open an issue for discussion instead.

# Testing

Test are implemented using `pytest`. After configuring your virtual environment and installing the dependencies, you can run the unittests with

    python3 -m pytest

# License and Terms

The relay.md backend software is licensed under AGPLv3. The full license can be found [here](https://github.com/relay-md/relay.md/blob/master/LICENSE).