Skip to content

Commit 16175ce

Browse files
committed
update readme
1 parent c5d1d95 commit 16175ce

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,56 @@
1-
# HackQC 2024
1+
<p align="center">
2+
<img src="img/logo_munis.png" alt="MUNIS Logo" width="200"/>
3+
</p>
24

3-
## Dev dependencies
5+
<h1 align="center">MUNIS - HackQC 2024</h1>
6+
<p align="center">Votre bouée communautaire au Québec.</p>
7+
8+
<p align="center">
9+
<img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License Badge"/>
10+
<img src="https://github.com/ClubCedille/hackqc2024/actions/workflows/main.yml/badge.svg" alt="Workflow Badge"/>
11+
</p>
12+
13+
## Description
14+
15+
MUNIS permet d'extraire les évènements d’urgence de multiples sources de données, permettant une réaction rapide et informée. En parallèle, la plateforme invite les utilisateurs à contribuer, permettant l'ajout de ressources d’aide qui viennent enrichir notre communauté de soutien. L'application comprend différentes sections dédiées à l'aide offerte et aux moyens de contribuer aux initiatives, facilitant ainsi l'engagement des utilisateurs.
16+
17+
## Dépendances
418

519
- [Go 1.22](https://go.dev/doc/install)
620
- [Air](https://github.com/cosmtrek/air)
721

8-
## Setup
22+
## Configuration
923

1024
### Nix
1125

12-
You can use nix to setup dependencies: `nix develop`
26+
Vous pouvez utiliser nix pour configurer les dépendances : `nix develop`
1327

14-
### Using Make (alternative)
28+
### Utilisation de Make (alternative)
1529

16-
Alternatively, you can manually initialize the project using the Makefile : `make init`
30+
Alternativement, vous pouvez initialiser manuellement le projet en utilisant le Makefile : `make init`
1731

18-
## How to run
32+
## Comment exécuter
1933

20-
In project root, run one of the following commands:
34+
Dans la racine du projet, exécutez l'une des commandes suivantes :
2135

22-
Go run:
36+
Exécution Go :
2337

2438
`go run .`
2539

26-
Live reload:
40+
Rechargement en direct :
2741

2842
`air`
2943

30-
### Using Makefile
44+
### Utilisation du Makefile
3145

3246
```bash
3347
make build
3448
make start
3549
```
3650

37-
#### with Docker
51+
#### Avec Docker
3852

39-
Build the Docker image and run the container on port 8080
53+
Construisez l'image Docker et exécutez le conteneur sur le port 8080
4054

4155
```bash
4256
make docker-build

img/logo_munis.png

36.5 KB
Loading

0 commit comments

Comments
 (0)