Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betagouv/preuve-covoiturage
Registre de preuve de covoiturage
https://github.com/betagouv/preuve-covoiturage
api betagouv carpooling covoiturage
Last synced: 25 days ago
JSON representation
Registre de preuve de covoiturage
- Host: GitHub
- URL: https://github.com/betagouv/preuve-covoiturage
- Owner: betagouv
- License: apache-2.0
- Created: 2018-11-07T15:21:03.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:43:48.000Z (about 2 months ago)
- Last Synced: 2024-10-29T11:48:22.069Z (about 2 months ago)
- Topics: api, betagouv, carpooling, covoiturage
- Language: TypeScript
- Homepage: https://app.covoiturage.beta.gouv.fr
- Size: 33.6 MB
- Stars: 34
- Watchers: 6
- Forks: 12
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Le registre de preuve de covoiturage est un projet [beta.gouv.fr](https://beta.gouv.fr) qui a pour but de certifier qu'un covoiturage a bien eu lieu. L'objectif de l'outil est d'agir en tant que tiers de confiance entre les différents acteurs du covoiturage (opérateurs, autorités organisatrices de mobilité, entreprises, régions, etc.) pour simplifier la mise en place d'incitations à destination des covoitureuses et covoitureurs. Cette Startup d'État a pour objectif d'aider à réduire l'auto-solisme et l'emprunte écologique des déplacements courts.
- Plus d'informations sur le [Registre de preuve de covoiturage](https://covoiturage.beta.gouv.fr/)
- [Application territoire/opérateurs](https://app.covoiturage.beta.gouv.fr)
- [Documentation générale](https://doc.covoiturage.beta.gouv.fr)
- [Documentation technique](https://tech.covoiturage.beta.gouv.fr)
- [Statistiques publiques](https://app.covoiturage.beta.gouv.fr/stats)
- [Metabase](https://stats.covoiturage.beta.gouv.fr)
- [Grafana](https://grafana.stats.covoiturage.beta.gouv.fr)
- [Page de statut des services](https://status.covoiturage.beta.gouv.fr)
- [Dépôt de l'application](https://github.com/betagouv/preuve-covoiturage) (monorepo)
- [Dépôt de l'infrastructure](https://github.com/betagouv/preuve-covoiturage-infra)
- [Dépôt de l'observatoire](https://github.com/betagouv/observatoire-covoiturage) (obsolète)
### Sécurité
Politique de sécurité et contact : [SECURITY.md](SECURITY.md)
### Services
An easy way to boot the application on your local machine is by using Docker.
You will need `docker` and `docker-compose`.
| Service | slug | ENV | URL | Folder |
| ----------- | ---------- | ----------------- | -------------------------- | ---------- |
| Frontend \* | `-` | APP_APP_URL | http://localhost:4200 | /dashboard |
| API | `api` | APP_API_URL | http://localhost:8080 | /api |
| Redis | `redis` | APP_REDIS_URL | redis://redis:6379 | - |
| Postgres | `postgres` | APP_POSTGRES_URL | postgresql://postgres:post | - |
| Mailhog | `mailer` | APP_MAIL_SMTP_URL | http://localhost:8025 | - |
| S3 | `s3` | AWS\_\* | http://localhost:9000 | - |
> ⚠️ `docker-compose.yml` is used in `local` environment only
### Installation
1. Cloner le repo et `cd` dedans
2. `cp api/.env.example api/.env`
3. Modifier `api/.env`
4. `docker-compose build`
5. `docker-compose run --rm migrator npm run migrate`
```shell
terminal 1: docker-compose up api
terminal 2: docker-compose up dashboard
# nav to http://localhost:4200
```
### Migrations
```shell
// use SKIP_GEO_MIGRATIONS=true to skip geo migrations
// use SKIP_SQL_MIGRATIONS=true to skip sql migrations
cd api
npm run migrate
// OR
docker-compose run api npm run migrate
```
### Frontend testing
```shell
# default browser is Chrome
npm run test
npm run test --browsers ChromeHeadless
CHROME_BIN=$(which chrome) npm run test
CHROME_BIN=$(which chromium) npm run test
CHROME_BIN=$(which brave-browser) npm run test
# requires karma-firefox-launcher (installed)
npm run test --browsers Firefox
```
##### Notes
- You can monitor your development inbox at http://localhost:8025. Emails are usually cleared in the tests.
- Tests are not stateless yet. You might need to clean up data manually when they crash.
### Configuration
#### Secrets configuration
For all **secrets**, use the `.env` file which is **NOT COMMITED** to Git.
For none secret values configuring the system, commit the ENV vars in `docker-compose.yml`
For _static_ application configuration (timeout, etc.) edit/add the `.ts` files in each service `config/` folder.
### Versions
The project follows the [semver](https://semver.org/) specification.
# License
DINUM / DGITM / ADEME, 2017-2024
The source code is published under [Apache license 2.0](./LICENSE).