Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Basic Development dependencies in readme #38

Closed
wants to merge 1 commit into from
Closed

Basic Development dependencies in readme #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down