Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reseauentourage/entourage-job
Webapp de recrutement pour le processus de réinsertion des personnes SDF et réfugiées . L'objectif est de guider et accompagner le candidat tout au long du parcours de recherche et de recrutement.
https://github.com/reseauentourage/entourage-job
airtable aws-s3 express nextjs passport react sequelize uikit
Last synced: about 2 months ago
JSON representation
Webapp de recrutement pour le processus de réinsertion des personnes SDF et réfugiées . L'objectif est de guider et accompagner le candidat tout au long du parcours de recherche et de recrutement.
- Host: GitHub
- URL: https://github.com/reseauentourage/entourage-job
- Owner: ReseauEntourage
- Archived: true
- Created: 2019-07-25T08:06:33.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-10-19T14:22:25.000Z (about 2 years ago)
- Last Synced: 2024-09-29T12:23:37.068Z (about 2 months ago)
- Topics: airtable, aws-s3, express, nextjs, passport, react, sequelize, uikit
- Language: JavaScript
- Homepage: https://entourage-job-preprod.herokuapp.com/
- Size: 207 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LinkedOut Backend
## Modules principaux & versions
> Node 14.x.x
> Express 4.17.2
> Sequelize 6.12.2
> ESLint 7.32.0
> Babel 7.16.5
## Architecture
- `.github`: configuration de la CI avec **_Github Actions_**
- `.husky` : scripts de hook de commit avec **_Husky_**
- `/public` : stockage des ressources non dynamique accessible publiquement
- `/src`
- `/constants` : fichiers de constantes
- `/controllers` : logiques métier de chaque use case de l'application
- `/helpers` : fichier d'utilitaire lié aux use cases
- `/jobs` : configuration des jobs asynchrones et gestions des jobs entrants
- `/routes` : configuration des routes avec **Express.js**
- `/db` : configuration de la base de données avec **Sequelize**
- `/config` : configuration d'accès à la base de données
- `/migrations`: fichiers de migration de la structure de la base
- `/models` : fichiers modèles des objets en base
- `/utils` : fonctions utilitaires communes
- `app.js`: point d'entrée de lancement du serveur
- `mainWorker.js`: point d'entrée de lancement du worker
- `server.js`: gestion du serveur
- `.babelrc` : configuration pour **_Babel_**
- `.editorconfig` : configuration par défaut de la syntaxe du code de l'éditeur
- `.env` : à ajouter pour gérer les variables d'environnements ([cf. exemple](#fichier-env-minimal))
- `.eslintignore` : configuration pour **_ESLint_**
- `.eslintrc.json` : configuration pour **_ESLint_**
- `.prettierignore` : configuration pour **_Prettier_**
- `.prettierrc.json` : configuration pour **_Prettier_**
- `.sequelizerc` : configuration pour **Sequelize**
- `.slugignore` : dossiers ou fichiers à exclure du package finale pendant la compilation
- `Procfile` : configuration des process **_Heroku_** à lancer après déploiement
## Configuration
### Pré-requis
Pour lancer le projet vous avez besoin de **Docker** ainsi que de **NodeJs**.
### Installation des modules sans Docker
```
npm install
```
### Initialisation des modules avec Docker
```
docker-compose up --build
```
### Initialisation de la BDD
#### Sans Docker
```
npm run db-create
```
Pour lancer les migrations :
```
npm run db-migrate
```
APour remplir la base de données avec un utilisateur administrateur permettant la création par la suite d'autres utilisateurs :
```
npm run db-seed
```
#### Avec Docker
La même chose que sans Docker, mais vous devez précéder les commandes par la suivante, et ne pas lancer la commande de création de DB:
```
docker exec -it api bash
```
### Une fois la DB initialisée
Les identifiants de l'administrateur crée sont :
> Adresse mail : **[email protected]**
>
> Mot de passe : **Admin123!**
### Remplir la DB avec un dump
#### Sans Docker
```
psql -d linkedout -p 5432 -U linkedout -W
```
Entrez le mdp de la BD (dans le docker-compose: "linkedout"), puis exécutez la commande SQL.
#### Avec Docker
Même chose que sans Docker, mais précédez par la commande suivante pour entrer dans le container de la DB:
```
docker exec -it db sh
```
### Lancer le projet en mode développement
#### Sans docker
```
npm run dev
```
#### Avec docker
```
docker-compose up
```
### Lancer le projet en mode production
```
npm run build
npm start
```
### Lancement du worker (si vous n'utilisez pas Docker)
#### Mode développement
Pour pouvoir utiliser le worker en local il faut lancer une instance de **_Redis_** en local : https://redis.io/docs/getting-started
Il faut également enlever les variables d'environnement _REDIS_URL_ et _REDIS_TLS_URL_ afin que les modules **_Redis_** et **_Bull_** utilisent leur configuration par défaut pour se connecter à _**Redis**_ en local (`127.0.0.1:6379`)
```
npm run dev-mainWorker
```
#### Mode production
```
npm run mainWorker
```
### Prettier + Linter
```
npm run lint
npm run format
```
Ces deux commandes sont lancées par les hooks de commit.
### Fichier `.env` minimal
```.dotenv
ACTIONS_REMINDER_DELAY=
ADMIN_CANDIDATES_HZ=
ADMIN_CANDIDATES_LILLE=
ADMIN_CANDIDATES_LYON=
ADMIN_CANDIDATES_PARIS=
ADMIN_COMPANIES_HZ=
ADMIN_COMPANIES_LILLE=
ADMIN_COMPANIES_LYON=
ADMIN_COMPANIES_PARIS=
AIRTABLE_API_KEY=
AIRTABLE_BASE_ID=
AIRTABLE_OFFERS=
AUTO_RECOMMENDATIONS_ZONE=
AWS_LAMBA_URL=
AWSS3_BUCKET_NAME=
AWSS3_FILE_DIRECTORY=
AWSS3_ID=
AWSS3_IMAGE_DIRECTORY=
AWSS3_SECRET=
BITLY_TOKEN=
CDN_ID=
CHROME_PATH=
CV_10_REMINDER_DELAY=
CV_20_REMINDER_DELAY=
CV_START_DELAY=
DATABASE_URL=
EXTERNAL_OFFERS_REMINDER_DELAY=
FRONT_URL=
INTERVIEW_TRAINING_REMINDER_DELAY=
JWT_SECRET=
MAILCHIMP_API_KEY=
MAILCHIMP_AUDIENCE_ID=
MAILJET_CONTACT_EMAIL=
MAILJET_FROM_EMAIL=
MAILJET_FROM_NAME=
MAILJET_PUB=
MAILJET_SEC=
MAILJET_SMS_TOKEN=
MAILJET_SUPPORT_EMAIL=
OFFER_NO_RESPONSE_DELAY=
OFFER_REMINDER_DELAY=
PORT=
PUSHER_API_KEY=
PUSHER_API_SECRET=
PUSHER_APP_ID=
PUSHER_URL=
REDIS_TLS_URL=
REDIS_URL=
SALESFORCE_CLIENT_ID=
SALESFORCE_CLIENT_SECRET=
SALESFORCE_LOGIN_URL=
SALESFORCE_PASSWORD=
SALESFORCE_REDIRECT_URI=
SALESFORCE_SECURITY_TOKEN=
SALESFORCE_USERNAME=
SENTRY_DSN=
SERVER_TIMEOUT=
USE_MAILJET_SMS=
USE_SMS=
VIDEO_REMINDER_DELAY=
VONAGE_API_KEY=
VONAGE_API_SECRET=
```
## Tests
### Initialisation de la BDD de test
```
docker run --name linkedout-db-test -e POSTGRES_PASSWORD=linkedout -e POSTGRES_USER=linkedout -e POSTGRES_DB=linkedout -d -p 54300:5432 postgres
```
Vous avez besoin des données du fichier `.env.test` pour les tests en local, et de renseigner le champ _DATABASE_URL_ (_ex:_ `postgresql://linkedout:linkedout@localhost:54300/linkedout`) avec l'adresse de l'instance **_Docker_**
```
NODE_ENV=dev-test npm run db-migrate
```
### Lancer les tests
- `npm run test` est utilisé pour l'intégration continue pour lancer les tests avec les valeurs du fichier `.env`
- `npm run dev-test` pour lancer les tests en local, en utilisant le fichier `.env.test`
## Déploiement
Le déploiement se fait automatiquement grâce à **_Github Actions_** et **_Heroku_**.
Si un commit est poussé sur `develop`, l'application sera déployé sur la pre-production : **[https://entourage-job-preprod.herokuapp.com](https://entourage-job-preprod.herokuapp.com)**
Si un commit est poussé sur `master`, l'application sera déployé sur la production : **[https://api.linkedout.fr](https://api.linkedout.fr)**
Les tests sont effectués sur **_Github Actions_** avant de déployer le projet sur **_Heroku_**.
## Stack technique
