Skip to content

Commit b6b71cb

Browse files
committed
docs: update README for French tech news aggregator and setup instructions
1 parent e563923 commit b6b71cb

File tree

1 file changed

+32
-19
lines changed

1 file changed

+32
-19
lines changed

README.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,63 @@
1-
# Actumatic
1+
# 📰 Actumatic
22

3-
Website to show last headlines of most famous news tech websites.
3+
### Aggrégateur d'actualités numériques et technologiques
4+
5+
Site web regroupant toutes les actualités tech francophones en temps réel par aggrégation de flux RSS.
6+
7+
🌱 Développé en clean architecture avec le gestionnaire de monorepo `nx`.
8+
9+
- Stack backend : Nest.js, Prisma, Jest
10+
11+
- Stack frontend : React, Redux Toolkit, Mantine, Vitest
412

513
## Setup
614

7-
- Install Postgresql and Node.
8-
- Create .env file based on .env.exemple and fill DATABASE_URL.
9-
- Install dependancies :
15+
Installer Postgresql et Node.js (ou utiliser Docker, voir ci-dessous)
16+
17+
Créer le fichier `.env` à partir du `.env.exemple` et modifiez la variable `DATABASE_URL`
18+
19+
Installer les dépendances :
1020

1121
```sh
1222
npm install
1323
```
1424

15-
- Create database and run migration :
25+
Créer la base de donnée et lancer la migration :
1626

1727
```sh
18-
# Create database
1928
createdb actumatic
20-
21-
# Run prisma migrations
2229
npx prisma migrate dev
2330
```
2431

25-
## Run tasks
32+
## Lancement
2633

27-
To run the dev server, use:
34+
Lancer le back et le front en mode dev :
2835

2936
```sh
3037
npm run backend:start
3138
npm run frontend:start
3239
```
3340

34-
To run both front & back in same command with :
41+
Pour build :
3542

3643
```sh
37-
npm run start
44+
npm run backend:build
45+
npm run frontend:build
3846
```
3947

40-
To create a production bundle of frontend:
48+
## Docker
49+
50+
Préparer les fichiers secrets :
4151

4252
```sh
43-
npx nx build frontend
53+
secrets/postgres_user # nom d'utilisateur postgres
54+
secrets/postgres_password # mot de passe postgres
55+
secrets/postgres_db # nom de la base de données dédiée au projet
56+
secrets/database_url # url d'accès (idem .env)
4457
```
58+
Modifier si besoin les ports dans le `compose.yaml`
4559

46-
To see all available targets to run for a project, run:
47-
60+
Puis lancer docker depuis le répertoire du projet :
4861
```sh
49-
npx nx show project frontend
50-
```
62+
docker compose up -d
63+
```

0 commit comments

Comments
 (0)