versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-06 08:28:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 📝 Clarify wording in contribution guide

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-11-07 13:15:58 +01:00
parent 93ebeba368
commit b2405bd118
No known key found for this signature in database
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -20,26 +20,25 @@ Versia Server is built using the following technologies:
To get started, please follow these steps: To get started, please follow these steps:
1. Fork the repository, clone it on your local system and make your own branch 1. Install the [Bun](https://bun.sh) runtime:
2. Install the [Bun](https://bun.sh) runtime:
```sh ```sh
curl -fsSL https://bun.sh/install | bash curl -fsSL https://bun.sh/install | bash
``` ```
1. Clone this repository 2. Clone this repository
```bash ```bash
git clone https://github.com/versia-pub/server.git git clone https://github.com/versia-pub/server.git
``` ```
2. Install the dependencies 3. Install the dependencies
```bash ```bash
bun install bun install
``` ```
3. Set up a PostgreSQL database (you need a special extension, please look at [the database documentation](docs/database.md)) 4. Set up a PostgreSQL database (you need a special extension, please look at [the database documentation](docs/database.md))
4. Copy the `config/config.example.toml` file to `config/config.toml` and edit it to set up the database connection and other settings. 5. Copy the `config/config.example.toml` file to `config/config.toml` and edit it to set up the database connection and other settings.
## HTTPS development ## HTTPS development
@ -53,7 +52,7 @@ mkcert -install
# *.localhost domains are automatically aliased to localhost by DNS # *.localhost domains are automatically aliased to localhost by DNS
mkcert -key-file config/versia.localhost-key.pem -cert-file config/versia.localhost.pem versia.localhost mkcert -key-file config/versia.localhost-key.pem -cert-file config/versia.localhost.pem versia.localhost
``` ```
3. Edit the config: 3. Edit the config to use your database and HTTPS certificates, e.g:
```toml ```toml
[http] [http]
base_url = "https://versia.localhost:9900" base_url = "https://versia.localhost:9900"