diff --git a/README.md b/README.md index 96a9b1a0..f1aa0bd9 100755 --- a/README.md +++ b/README.md @@ -45,6 +45,23 @@ Please consider [sponsoring](https://github.com/sponsors/frikky) the project if ## Documentation [Documentation](https://shuffler.io/docs) can be found on [https://shuffler.io/docs](https://shuffler.io/docs) and is written here: [https://github.com/frikky/shuffle-docs](https://github.com/frikky/shuffle-docs). +### Setting up a local development environment + +For the backend, you need to have [Go](https://golang.org/doc/install) installed. For the frontend, you need to have [Node.js](https://nodejs.org/en/download/) installed. + +Checkout [this](./backend/README.md) to get started with running the backend locally. +You can run the frontend locally by running the following commands: + +```bash +cd frontend +yarn install +yarn start +``` + +And then, you can access the frontend at [http://localhost:3000](http://localhost:3000). + +Make sure to also start the database by running `docker-compose up opensearch -d` in the root directory. + ## Related repositories * OpenAPI apps: [https://github.com/frikky/security-openapis](https://github.com/frikky/security-openapis) * Documentation: [https://github.com/frikky/shuffle-docs](https://github.com/frikky/shuffle-docs)