diff --git a/README.md b/README.md index c1275fb..0d1fca1 100644 --- a/README.md +++ b/README.md @@ -162,53 +162,9 @@ There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-sy - Italian by [@nicfab](https://notes.nicfab.eu/it/posts/cryptgeon/) - English by [@nicfab](https://notes.nicfab.eu/en/posts/cryptgeon/) -## Development +## Contributing -**Requirements** - -- `pnpm`: `>=11` -- `node`: `>=24` -- `rust`: edition `2024` - -**Install** - -```bash -pnpm install - -# Also you need cargo watch if you don't already have it installed. -# https://lib.rs/crates/cargo-watch -cargo install cargo-watch -``` - -**Run** - -Make sure you have docker running. - -```bash -pnpm run dev -``` - -Running `pnpm run dev` in the root folder will start the following things: - -- redis docker container -- rust backend -- client -- cli - -You can see the app under [localhost:3000](http://localhost:3000). - -> There is a Postman collection with some example requests [available in the repo](./Cryptgeon.postman_collection.json) - -### Tests - -Tests are end to end tests written with Playwright. - -```sh -pnpm run test:prepare - -# Use the test or test:local script. The local version only runs in one browser for quicker development. -pnpm run test:local -``` +See [CONTRIBUTING.md](./CONTRIBUTING.md). ## Security diff --git a/README_ES.md b/README_ES.md index 890e21d..e2e9642 100644 --- a/README_ES.md +++ b/README_ES.md @@ -141,53 +141,9 @@ Hay una [guía](https://mariushosting.com/how-to-install-cryptgeon-on-your-synol - En inglés, por [DB Tech](https://www.youtube.com/watch?v=S0jx7wpOfNM) [Previous Video](https://www.youtube.com/watch?v=JhpIatD06vE) - En alemán, por [ApfelCast](https://www.youtube.com/watch?v=84ZMbE9AkHg) -## Desarrollo +## Contribuir -**Requisitos** - -- `pnpm`: `>=6` -- `node`: `>=18` -- `rust`: edition `2021` - -**Instalación** - -```bash -pnpm install - -# También necesitas cargo-watch, si no lo tienes instalado. -# https://lib.rs/crates/cargo-watch -cargo install cargo-watch -``` - -**Ejecutar** - -Asegúrate de que docker se esté ejecutando. - -```bash -pnpm run dev -``` - -Ejecutando `pnpm run dev` en la carpeta raíz iniciará lo siguiente: - -- redis docker container -- rust backend -- client -- cli - -Puedes ver la app en [localhost:3000](http://localhost:3000). - -> Existe una colección de Postman con algunas peticiones de ejemplo [disponible en el repo](./Cryptgeon.postman_collection.json) - -### Tests - -Los tests son end-to-end tests escritos con Playwright. - -```sh -pnpm run test:prepare - -# Usa el script test o test:local. La versión local solo corre en el navegador para acelerar el desarrollo. -pnpm run test:local -``` +Ver [CONTRIBUTING.md](./CONTRIBUTING.md). ## Seguridad diff --git a/README_zh-CN.md b/README_zh-CN.md index 803df38..ea7200d 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -140,54 +140,9 @@ services: - traefik.http.routers.cryptgeon.tls.certresolver=le ``` -## 开发 +## 贡献 -**环境要求** - -- `pnpm`: `>=6` -- `node`: `>=14` -- `rust`: edition `2021` - -**安装** - -```bash -pnpm install -pnpm --prefix frontend install - -# 你还需要安装CargoWatch. -# https://lib.rs/crates/cargo-watch -cargo install cargo-watch -``` - -**运行** - -确保你的 Docker 正在运行 - -```bash -pnpm run dev -``` - -在根目录执行 `pnpm run dev` 会开启下列服务: - -- 一个 redis docker 容器 -- 无热重载的 rust 后端 -- 可热重载的客户端 - -你可以通过 3000 端口进入该应用,即 [localhost:3000](http://localhost:3000). - -## 测试 - -这些测试是用 Playwright 实现的一些端到端测试用例。 - -```sh -pnpm run test:prepare -docker compose up redis -d -pnpm run test:server - -# 在另一个终端中: -# 使用test或者test:local script。为了更快的开发,本地版本只会在一个浏览器中运行。 -pnpm run test:local -``` +参见 [CONTRIBUTING.md](./CONTRIBUTING.md)。 ###### Attributions