From d77c31e2142f228b6d901848bd0b6a217d44587c Mon Sep 17 00:00:00 2001 From: Piotr Stachyra Date: Fri, 4 Oct 2024 13:04:24 +0200 Subject: [PATCH] Basic Development dependencies in readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index fa3182f..ba5baca 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,30 @@ mina-mesh serve --playground Visit [`http://0.0.0.0:3000`](http://0.0.0.0:3000) for an interactive playground with which you can explore and test endpoints. +## Development Dependencies + +- **Rust Toolchain**: The project is written in Rust, so you'll need the Rust compiler and package + manager (`cargo`). Follow the [installation instructions](https://www.rust-lang.org/tools/install) + if you haven't already. + +- **dprint**: We use `dprint` for formatting various file types (e.g., JSON, Markdown, TOML, SQL). + To install `dprint`, you can use `cargo`. + +- **sql-formatter**: The project uses `sql-formatter` to format SQL files, which is invoked through + `dprint`. To install `sql-formatter`, use `npm`: + + ```sh + npm install -g sql-formatter + ``` + +- **VSCode Extensions** (Optional but Recommended): If you use VSCode, the project includes a + `.vscode/settings.json` file to help standardize the development experience. We recommend + installing the following extensions: + - [dprint](https://marketplace.visualstudio.com/items?itemName=dprint.dprint) + - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + - [Rust Analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) + - [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) + ## Code of Conduct Everyone interacting in this repo is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).