Skip to content
This repository was archived by the owner on Feb 11, 2025. It is now read-only.

Commit e48f3e7

Browse files
docs: update project status
1 parent ee8ee7e commit e48f3e7

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1+
# trouver-une-fresque-front
2+
13
![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg)
24

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
47

58
Merci :) Ton aide est la bienvenue !
69

710
Le guide de contribution se trouve dans le fichier [CONTRIBUTING.md](./CONTRIBUTING.md)
811

9-
# Requirements
12+
## Requirements
1013

1114
You need minimum `node@12` to be able to properly run `ViteJS`
1215

1316
Don't hesitate to install multiple `node` version in your dev environment using [n](https://www.npmjs.com/package/n)
1417

15-
# Boostrap
18+
## Boostrap
1619

1720
Install dependencies :
1821
`npm ci`
@@ -25,13 +28,13 @@ and enjoy live reload / on-the-fly typescript compilation
2528

2629
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.
2730

28-
## Alternative: Running with docker
31+
### Alternative: Running with docker
2932
If you don't want to install node.js on your machine, you can isolate it with [docker](https://www.docker.com/get-started):
3033

3134
Start docker container (that executes `npm run dev`) :
3235
`docker-compose up`
3336

34-
### Docker how-to
37+
#### Docker how-to
3538
The first time `docker-compose up` is run, it will build the `base` docker image with `npm install` inside `node:14` docker image.
3639

3740
When the `package*.json` have changed, you need to rebuild the base image:
@@ -44,19 +47,14 @@ docker-compose build
4447

4548
To inspect what happens inside : `docker-compose exec frontend bash`
4649

47-
# Production
50+
## Production
4851

4952
Package for production with `vite build` : `dist` directory will contain minified assets for production
5053

5154
For debug purposes, if you want to generate sourcemaps for production build, you can configure
5255
`vite.config.ts` file by changing the `build.sourcemap` config property to `true`
5356

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
6058

6159
- `main` is automatically deployed on TODO
6260

@@ -67,7 +65,7 @@ TODO
6765
We generally try to create dedicated feature branches with issue number in it, except when the
6866
commit is really small
6967

70-
# Stack pointers
68+
## Stack pointers
7169

7270
We're using :
7371

@@ -78,6 +76,6 @@ We're using :
7876
- **SASS** as CSS transpiler => [documentation](https://sass-lang.com/documentation)
7977
- **ViteJS** for the development/production build toolchain => [guide](https://vitejs.dev/guide/)
8078

81-
# Crédits
79+
## Crédits
8280

8381
[Terre icônes créées par Freepik - Flaticon](https://www.flaticon.com/fr/icones-gratuites/terre)

0 commit comments

Comments
 (0)