Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.24 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.24 KB

biasdo

biasdo is an open source chat app made for users, by users.

Technologies

biasdo uses technologies made by the open source community, and a detailed list can be found in the root package.json, client package.json, and backend Cargo.toml, but the core technologies are:

Public instance

The official public biasdo instance is hosted by fly.io (backend) and Vercel (frontend). The instance is available at biasdo.daimond113.com, and it's api at api.biasdo.daimond113.com.

Self-hosting

Client

  1. Clone the repository
  2. Go into the packages/client directory and create a .env file with the following contents:
VITE_API_URL= # the url of the api, for example https://api.biasdo.daimond113.com/v0 (IMPORTANT: do not include a trailing slash)
  1. Install the dependencies
  2. Now you can follow the usual steps to run a SvelteKit app, which can be found here

API

  1. Clone the repository
  2. Create a .env file with the following contents:
DATABASE_URL= # the url of the database, for example mysql://root:password@localhost:3306/biasdo (IMPORTANT: biasdo uses MariaDB, and has not been tested with MySQL)
  1. Install the dependencies
  2. Create the database using CREATE DATABASE <name in the url>;
  3. Now you can build and run the app like any other Cargo project

Contributing

As the motto says, biasdo is made for users, by users. If you want to contribute, you can do so by opening a pull request. If you want to contribute but don't know how, or report an issue, you can check out the GitHub issues.

License

This project is licensed under the MIT License.