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
{{ message }}
This repository was archived by the owner on Feb 11, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,21 @@
1
+
# trouver-une-fresque-front
2
+
1
3

2
4
3
-
# Contribuer
5
+
📝 **Note:** This project has been rewritten using Vue 3. The new version can be found [here](https://github.com/trouver-une-fresque/multiworkshop-taskforce-front). This repository is now archived.
6
+
## Contribuer
4
7
5
8
Merci :) Ton aide est la bienvenue !
6
9
7
10
Le guide de contribution se trouve dans le fichier [CONTRIBUTING.md](./CONTRIBUTING.md)
8
11
9
-
# Requirements
12
+
##Requirements
10
13
11
14
You need minimum `node@12` to be able to properly run `ViteJS`
12
15
13
16
Don't hesitate to install multiple `node` version in your dev environment using [n](https://www.npmjs.com/package/n)
14
17
15
-
# Boostrap
18
+
##Boostrap
16
19
17
20
Install dependencies :
18
21
`npm ci`
@@ -25,13 +28,13 @@ and enjoy live reload / on-the-fly typescript compilation
25
28
26
29
You can also click on [this link](https://gitpod.io/#https://github.com/trouver-une-fresque/trouver-une-fresque-front) in order to open a Gitpod workspace with everything loaded in it.
27
30
28
-
## Alternative: Running with docker
31
+
###Alternative: Running with docker
29
32
If you don't want to install node.js on your machine, you can isolate it with [docker](https://www.docker.com/get-started):
30
33
31
34
Start docker container (that executes `npm run dev`) :
32
35
`docker-compose up`
33
36
34
-
### Docker how-to
37
+
####Docker how-to
35
38
The first time `docker-compose up` is run, it will build the `base` docker image with `npm install` inside `node:14` docker image.
36
39
37
40
When the `package*.json` have changed, you need to rebuild the base image:
@@ -44,19 +47,14 @@ docker-compose build
44
47
45
48
To inspect what happens inside : `docker-compose exec frontend bash`
46
49
47
-
# Production
50
+
##Production
48
51
49
52
Package for production with `vite build` : `dist` directory will contain minified assets for production
50
53
51
54
For debug purposes, if you want to generate sourcemaps for production build, you can configure
52
55
`vite.config.ts` file by changing the `build.sourcemap` config property to `true`
53
56
54
-
# Mobile apps
55
-
56
-
TODO
57
-
<!-- See [vitemadose-android](https://github.com/CovidTrackerFr/vitemadose-android) and [vitemadose-ios](https://github.com/CovidTrackerFr/vitemadose-ios). -->
58
-
59
-
# Development workflow
57
+
## Development workflow
60
58
61
59
-`main` is automatically deployed on TODO
62
60
@@ -67,7 +65,7 @@ TODO
67
65
We generally try to create dedicated feature branches with issue number in it, except when the
68
66
commit is really small
69
67
70
-
# Stack pointers
68
+
##Stack pointers
71
69
72
70
We're using :
73
71
@@ -78,6 +76,6 @@ We're using :
78
76
-**SASS** as CSS transpiler => [documentation](https://sass-lang.com/documentation)
79
77
-**ViteJS** for the development/production build toolchain => [guide](https://vitejs.dev/guide/)
80
78
81
-
# Crédits
79
+
##Crédits
82
80
83
81
[Terre icônes créées par Freepik - Flaticon](https://www.flaticon.com/fr/icones-gratuites/terre)
0 commit comments