Skip to content

Commit 3472729

Browse files
authored
fix: add readme instructions for local install (#2142)
1 parent 8f69d2a commit 3472729

1 file changed

Lines changed: 36 additions & 4 deletions

File tree

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ Head over to: [Client](https://github.com/graasp/client), [Library](https://gith
2020

2121
In order to run the Graasp backend, it requires:
2222

23-
- Node version 24
24-
- NPM version 11
25-
- Yarn (can be installed through [`nvm`](https://github.com/nvm-sh/nvm))
23+
- [Mise](https://mise.jdx.dev) (tool manager)
2624
- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/): Docker is not necessary, it is possible to install everything locally. However it is strongly recommended to use the Docker installation guide.
2725

26+
Mise will automatically install the correct version of node and pnpm. You should only have to do:
27+
`mise install`. You might have to trust the workspace with `mise trust` first.
28+
Then when you call `pnpm i` it will ask you to download pnpm via corepack. Accept.
29+
2830
## Recommended Tools
2931

30-
- [NVM](https://github.com/nvm-sh/nvm) or [Volta (recommended)](https://volta.sh/) : CLI to manage multiple versions of NodeJs and NPM.
3132
- [Postman](https://www.postman.com) : Application to explore and test your APIs.
3233
- [Starship](https://starship.rs/): A shell prompt enhancer that shows you the current git branch nvm version and package version, very useful for quick look at your environment (works on all shells and is super fast), requires you to use a [NerdFont](https://www.nerdfonts.com/)
3334
- [VS Code](https://code.visualstudio.com) : IDE to manage the database and make changes to the source code.
@@ -110,6 +111,8 @@ To configure the application, you'll need to change the values in `.env.developm
110111
```bash
111112
### Graasp back-end configuration
112113

114+
LOG_LEVEL=debug
115+
113116
### Network configuration
114117

115118
# Default protocol is already set
@@ -222,6 +225,35 @@ OPENAI_API_KEY=<openai-api-key>
222225

223226
# GEOLOCATION API - this can be empty if you don't use geolocation
224227
GEOLOCATION_API_KEY=
228+
229+
230+
### If running outside of the devcontainer where some default vars are set and available for you, un-comment the ones below:
231+
# MAILER_CONNECTION=smtp://docker:docker@mailer:1025
232+
#
233+
# ETHERPAD_URL=http://localhost:9001
234+
# ETHERPAD_PUBLIC_URL=http://localhost:9001
235+
# ETHERPAD_COOKIE_DOMAIN=localhost
236+
# ETHERPAD_API_KEY=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
237+
#
238+
# EMBEDDED_LINK_ITEM_IFRAMELY_HREF_ORIGIN=http://localhost:8061
239+
#
240+
# DB_CONNECTION=postgres://graasper:graasper@localhost:5432/graasp
241+
#
242+
# H5P_FILE_STORAGE_HOST=http://s3.garage.localhost:3900
243+
# H5P_INTEGRATION_URL=http://h5p-items.web.garage.localhost:3902/h5p-integration/
244+
#
245+
# FILE_STORAGE_TYPE=s3
246+
# S3_FILE_ITEM_HOST=http://s3.garage.localhost:3900
247+
# S3_FILE_ITEM_REGION=garage
248+
# S3_FILE_ITEM_BUCKET=file-items
249+
#
250+
# MEILISEARCH_URL=http://localhost:7700
251+
#
252+
# REDIS_CONNECTION=redis://localhost:6379
253+
254+
## Optionally override the port so it works with the reverse proxy
255+
# PORT=3001
256+
225257
```
226258

227259
### Garage

0 commit comments

Comments
 (0)