Skip to content

Commit e7ea9be

Browse files
authored
fix: some typo in the readme (#1894)
1 parent 8809abc commit e7ea9be

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,46 @@
66

77
<!-- ALL-CONTRIBUTORS-BADGE:END -->
88

9-
[![GitHub Release](https://img.shields.io/github/release/graasp/graasp)]()
9+
[![GitHub Release](https://img.shields.io/github/release/graasp/graasp)](https://github.com/graasp/graasp/releases/latest)
1010
![Test CI](https://github.com/graasp/graasp/actions/workflows/test.yml/badge.svg?branch=main)
1111
![typescript version](https://img.shields.io/github/package-json/dependency-version/graasp/graasp/dev/typescript)
12-
<a href="https://gitlocalize.com/repo/9284?utm_source=badge"> <img src="https://gitlocalize.com/repo/9284/whole_project/badge.svg" /> </a>
12+
[![Translations](https://gitlocalize.com/repo/9284/whole_project/badge.svg)](https://gitlocalize.com/repo/9284?utm_source=badge)
1313

14-
This repository contains the source code and confgurations for the Graasp Backend. Visit the Graasp Platform at [graasp.org](https://graasp.org)
14+
This repository contains the source code and configurations for the Graasp backend. Visit the Graasp Platform at [graasp.org](https://graasp.org)
1515

16-
❓Looking for our client applications/frontends ?
17-
Head over to: [Builder](https://github.com/graasp/graasp-builder), [Player](https://github.com/graasp/graasp-player), [Library](https://github.com/graasp/graasp-library), [Analytics](https://github.com/graasp/graasp-analytics) or [Account](https://github.com/graasp/graasp-account)
16+
❓Looking for our client applications/front-ends ?
17+
Head over to: [Client](https://github.com/graasp/client), [Library](https://github.com/graasp/graasp-library)
1818

1919
## Requirements
2020

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

23-
- Node v20
24-
- NPM v10
23+
- Node version 22
24+
- NPM version 10
2525
- Yarn (can be installed through [`nvm`](https://github.com/nvm-sh/nvm))
26-
- [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 recommanded to use the Docker installation guide.
26+
- [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.
2727

2828
## Recommended Tools
2929

30-
- [NVM](https://github.com/nvm-sh/nvm) or [Volta (recommended)](https://volta.sh/) : CLI to manage multiple versions of Node.js and NPM.
30+
- [NVM](https://github.com/nvm-sh/nvm) or [Volta (recommended)](https://volta.sh/) : CLI to manage multiple versions of NodeJs and NPM.
3131
- [Postman](https://www.postman.com) : Application to explore and test your APIs.
32-
- [Starship](https://starship.rs/): A shell prompt enhancer that shows you the current git branch nvm version and package version, very usefull for quick look at your environment (works on all shells and is super fast), requires you to use a [NerdFont](https://www.nerdfonts.com/)
32+
- [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/)
3333
- [VS Code](https://code.visualstudio.com) : IDE to manage the database and make changes to the source code.
3434

35-
- [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) : A extension for VS Code. It allows to easily setup the dev environnement.
35+
- [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) : A extension for VS Code. It allows to easily setup the dev environment.
3636

3737
- [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) : A extension for VS Code. It allows easy access to the database.
3838

3939
## Installation
4040

4141
Graasp offers two ways to install the Graasp backend :
4242

43-
- [Docker](#docker-installation) (recommended) : this allows you to run a preconfigured environnement
43+
- [Docker](#docker-installation) (recommended) : this allows you to run a preconfigured environment
4444
- [Local](#local-installation) : you'll need to install and configure all the required services
4545

4646
### Docker installation
4747

48-
We recommend to set up the development environment using Docker, as it allows to use a preconfigured developement environnement.
48+
We recommend to set up the development environment using Docker, as it allows to use a preconfigured development environment.
4949

5050
First open the folder in the dev-container by using the command palette <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>P</kbd> (or <kbd>ctrl</kbd> instead of <kbd>cmd</kbd>), and typing `Open Folder in Container`.
5151

@@ -62,7 +62,7 @@ This will create 10 containers :
6262
- `mailer` : Simple mailer instance used to receive emails locally (see the [Utilities section](#utilities))
6363

6464
> **Important**
65-
> To use localstack with the Docker installation, it is necessary to edit your `/etc/hosts` with the following line `127.0.0.1 localstack`. This is necessary because the backend creates signed urls with the localstack container hostname. Without changing the hosts, the developpement machine cannot resolve the `http://localstack` hostname.
65+
> To use localstack with the Docker installation, it is necessary to edit your `/etc/hosts` with the following line `127.0.0.1 localstack`. This is necessary because the backend creates signed urls with the localstack container hostname. Without changing the hosts, the development machine cannot resolve the `http://localstack` hostname.
6666
6767
Then install the required npm packages with `yarn install`. You should run this command in the docker's terminal, because some packages are built depending on the operating system (eg. `bcrypt`).
6868

@@ -80,7 +80,7 @@ It will create 4 roles with their associated database for the services that need
8080

8181
- Graasp: the db for the backend
8282
- Umami: google analytics replacement
83-
- Etherpad: realtime documents
83+
- Etherpad: real-time documents
8484
- Test: a test database that will be wiped during tests
8585

8686
### Local Installation
@@ -132,16 +132,16 @@ SECURE_SESSION_SECRET_KEY=<secret-key>
132132
JWT_SECRET=<secret-key>
133133
# Auth JWT secret (can use the same command as for SECURE_SESSION_SECRET_KEY)
134134
AUTH_TOKEN_JWT_SECRET=<secret-key>
135-
AUTH_TOKEN_EXPIRATION_IN_MINUTES=10080
135+
# AUTH_TOKEN_EXPIRATION_IN_MINUTES=10080
136136
# Refresh JWT secret (can use the same command as for SECURE_SESSION_SECRET_KEY)
137137
REFRESH_TOKEN_JWT_SECRET=<secret-key>
138-
REFRESH_TOKEN_EXPIRATION_IN_MINUTES=86400
138+
# REFRESH_TOKEN_EXPIRATION_IN_MINUTES=86400
139139
# Password reset JWT secret (can use the same command as for SECURE_SESSION_SECRET_KEY)
140140
PASSWORD_RESET_JWT_SECRET=<secret-key>
141-
PASSWORD_RESET_JWT_EXPIRATION_IN_MINUTES=1440
141+
# PASSWORD_RESET_JWT_EXPIRATION_IN_MINUTES=1440
142142
# Email change JWT secret (can use the same command as for SECURE_SESSION_SECRET_KEY)
143143
EMAIL_CHANGE_JWT_SECRET=<secret-key>
144-
EMAIL_CHANGE_JWT_EXPIRATION_IN_MINUTES=1440
144+
# EMAIL_CHANGE_JWT_EXPIRATION_IN_MINUTES=1440
145145

146146

147147
### Mail server configuration
@@ -181,7 +181,7 @@ H5P_FILE_STORAGE_HOST=http://localhost:1081
181181
### External services configuration
182182

183183
# Graasp Etherpad (set by ./.devcontainer/docker-compose.yml)
184-
# ETHERPAD_URL=http://etherpad:9001
184+
# ETHERPAD_URL=http://etherpad:9001
185185
# Optional, if the etherpad server has a different public URL than what the back-end uses to communicate with the service (e.g. private network)
186186
# ETHERPAD_PUBLIC_URL=http://localhost:9001
187187
# Optional, if the etherpad cookie domain is different from the domain of the public URL
@@ -197,6 +197,8 @@ H5P_FILE_STORAGE_HOST=http://localhost:1081
197197
APPS_JWT_SECRET=<secret-key>
198198
APPS_PUBLISHER_ID=<id>
199199

200+
GRAASPER_CREATOR_ID=<id>
201+
200202
# Graasp websockets
201203
# Redis config set by ./.devcontainer/docker-compose.yml
202204
# REDIS_HOST=redis
@@ -218,7 +220,7 @@ GRAASP_MOBILE_BUILDER=graasp-mobile-builder
218220
# get a recaptcha secret access key for your hostname at http://www.google.com/recaptcha/admin
219221
RECAPTCHA_SECRET_ACCESS_KEY=<google-recaptcha-key>
220222
# Graasp search
221-
MEILISEARCH_URL=http://graasp-meilisearch:7700
223+
MEILISEARCH_URL=http://meilisearch:7700
222224
MEILISEARCH_MASTER_KEY=masterKey
223225
MEILISEARCH_REBUILD_SECRET=secret
224226

@@ -236,7 +238,7 @@ GEOLOCATION_API_KEY=
236238
### Umami
237239

238240
To log into umami in your local instance:
239-
https://umami.is/docs/login
241+
<https://umami.is/docs/login>
240242

241243
The first time you log in use username: `admin` and password: `umami`. It is recommended to change these.
242244

0 commit comments

Comments
 (0)