Skip to content
Snippets Groups Projects

Add documentation

2 files
+ 23
25
Compare changes
  • Side-by-side
  • Inline

Files

@@ -24,7 +24,7 @@ Or via Node Version Manager (NVM) by following the instructions on the [official
@@ -24,7 +24,7 @@ Or via Node Version Manager (NVM) by following the instructions on the [official
## Dependencies
## Dependencies
Here are the main dependencies used by the API (you don't need to install them manually or globally on your system):
Here are the main dependencies used by the API (you do not need to install them manually or globally on your system):
- [Axios](https://www.npmjs.com/package/axios): a promise-based HTTP client for the browser and Node.js. It is
- [Axios](https://www.npmjs.com/package/axios): a promise-based HTTP client for the browser and Node.js. It is
used to make HTTP(S) requests to the Dojo backend and Gitlab.
used to make HTTP(S) requests to the Dojo backend and Gitlab.
- [Dotenv](https://www.npmjs.com/package/dotenv): used to load environment variables from a .env file.
- [Dotenv](https://www.npmjs.com/package/dotenv): used to load environment variables from a .env file.
@@ -83,10 +83,10 @@ Set DOTENV_KEY on your server
@@ -83,10 +83,10 @@ Set DOTENV_KEY on your server
## Database
## Database
For development, you can use the docker-compose file in the `Resources/DevInfra/` folder.
For the development, you can use the docker-compose file in the `Resources/DevInfra/` folder.
```bash
```bash
docker-compose -f Resources/DevInfra/docker-compose.yml up -d
docker compose -f Resources/DevInfra/docker-compose.yml up -d
```
```
This will run a MariaDB database on port `59231` with the following credentials: `root:9buz7f312479g6234f1gnioubervw79b8z`
This will run a MariaDB database on port `59231` with the following credentials: `root:9buz7f312479g6234f1gnioubervw79b8z`
Loading