You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
15
15
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)
18
18
19
19
## Requirements
20
20
21
21
In order to run the Graasp backend, it requires:
22
22
23
-
- Node v20
24
-
- NPM v10
23
+
- Node version 22
24
+
- NPM version 10
25
25
- 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.
27
27
28
28
## Recommended Tools
29
29
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.
31
31
-[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/)
33
33
-[VS Code](https://code.visualstudio.com) : IDE to manage the database and make changes to the source code.
34
34
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.
36
36
37
37
-[SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) : A extension for VS Code. It allows easy access to the database.
38
38
39
39
## Installation
40
40
41
41
Graasp offers two ways to install the Graasp backend :
42
42
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
44
44
-[Local](#local-installation) : you'll need to install and configure all the required services
45
45
46
46
### Docker installation
47
47
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.
49
49
50
50
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`.
51
51
@@ -62,7 +62,7 @@ This will create 10 containers :
62
62
-`mailer` : Simple mailer instance used to receive emails locally (see the [Utilities section](#utilities))
63
63
64
64
> **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.
66
66
67
67
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`).
68
68
@@ -80,7 +80,7 @@ It will create 4 roles with their associated database for the services that need
80
80
81
81
- Graasp: the db for the backend
82
82
- Umami: google analytics replacement
83
-
- Etherpad: realtime documents
83
+
- Etherpad: real-time documents
84
84
- Test: a test database that will be wiped during tests
0 commit comments