\ ˈbrēf \ - short in duration, extent or length
Brief - schriftliche, in einem Umschlag übersandte Mitteilung

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Features
• Usage
  • Web
  • API
  • Dev
• Contributing
• Contact
• Licenses

About The Project

Have you ever felt the need to send a brief message to someone but not through those unpersonal messager apps? Brief has you covered!

With Brief you can send short messages (30 chars max.) to other people.

Features

• Core
  • Create a "Brief"
  • View a "Brief"
  • Share using the native Share API
  • Copy URL to clipboard
• API
  • /encode Endpoint to encode arbitrary messages

Usage

Web

It's pretty simple. Enter a message and share the url with someone else.

API

Send a POST request to /encode with the following JSON body:

{
    "message": "your message goes here!"
}

You will receive the following response if everything went well (Status 400 if not):

{
    "data": "base64 encoded message data"
}

Dev

This project uses Svelte Kit please refer to it's documentation for further information.

# === DEVELOPMENT

# Install dependencies
npm install

# Start the dev server
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

# === BUILD
# Change the adapter in /svelte.config.cjs if you don't want to use Vercel!

# Build the project
npm run build

You can preview the built app with npm run preview, regardless of whether you installed an adapter. This should not be used to serve your app in production.

Contributing

Feel free to contribute to this project if you find something that is missing or can be optimized. If you do so, please follow the following steps:

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

Contact

Maximilian Heidenreich - github@maximilian-heidenreich.de

Project Link: https://github.com/MaximilianHeidenreich/Brief

Project Banner: https://github.com/MaximilianHeidenreich/Brief/blob/master/static/brief_banner.png

Licenses

The project uses Twemoji for its favicon and banner image.

“Twemoji” by Twitter OSS is licensed under CC-BY 4.0.