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

Update contribution guide

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-03-10 20:01:10 -10:00
parent ae857cd4fa
commit 04dcaa94aa
No known key found for this signature in database
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -1,5 +1,6 @@
# Contributing to Lysand # Contributing to Lysand
> [!NOTE]
> This document was authored by [@CPlusPatch](https://github.com/CPlusPatch). > This document was authored by [@CPlusPatch](https://github.com/CPlusPatch).
Thank you for your interest in contributing to Lysand! We welcome contributions from everyone, regardless of their level of experience or expertise. Thank you for your interest in contributing to Lysand! We welcome contributions from everyone, regardless of their level of experience or expertise.
@ -8,7 +9,7 @@ Thank you for your interest in contributing to Lysand! We welcome contributions
Lysand is built using the following technologies: Lysand is built using the following technologies:
- [Bun](https://bun.sh) - A JavaScript runtime similar to Node.js, but improved - [Bun](https://bun.sh) - A JavaScript runtime similar to Node.js, but faster and with more features
- [PostgreSQL](https://www.postgresql.org/) - A relational database - [PostgreSQL](https://www.postgresql.org/) - A relational database
- [`pg_uuidv7`](https://github.com/fboulnois/pg_uuidv7) - A PostgreSQL extension that provides a UUIDv7 data type - [`pg_uuidv7`](https://github.com/fboulnois/pg_uuidv7) - A PostgreSQL extension that provides a UUIDv7 data type
- [UnoCSS](https://unocss.dev) - A utility-first CSS framework, used for the login page - [UnoCSS](https://unocss.dev) - A utility-first CSS framework, used for the login page
@ -69,7 +70,7 @@ RUN chmod +x /docker-entrypoint-initdb.d/init.sh
4. Copy the `config.toml.example` file to `config.toml` and fill in the values (you can leave most things to the default, but you will need to configure things such as the database connection) 4. Copy the `config.toml.example` file to `config.toml` and fill in the values (you can leave most things to the default, but you will need to configure things such as the database connection)
> [!WARNING] > [!WARNING]
> You should disable Prisma caching while developing, as it can mess up tests > You should disable Prisma Redis caching while developing, as it can mess up tests
5. Generate the Prisma client: 5. Generate the Prisma client:
@ -108,7 +109,7 @@ To run the tests, run:
bun test bun test
``` ```
The tests are located in the `tests/` directory and follow a Jest-like syntax. The server must be started with `bun dev` before running the tests. The tests are located in the `tests/` directory and follow a Jest-like syntax. The server does not need to be started before running the tests, as the tests will spawn their own Lysand server instance.
## Code style ## Code style