From f6e18f0272fefaea7633fee3bdd8fd886a641699 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Parmentier?= Date: Tue, 8 Oct 2024 15:41:11 +0200 Subject: [PATCH] style: Spell --- .vscode/settings.json | 6 ++++++ README.md | 4 ++-- tdm-admin/README.md | 4 ++-- tdm-be/README.md | 2 +- tdm-fe/README.md | 2 +- 5 files changed, 12 insertions(+), 6 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..f053157 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "cSpell.words": [ + "Backoffice", + "dockerized" + ] +} diff --git a/README.md b/README.md index 091b388..0e3c3bb 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,11 @@ docker run -p 3000:3000 tdm:v1.0.0 ``` The frontend will be accessible at `http://localhost:3000/`, the swagger configuration -at `http://localhost:3000/swagger-config` and the backoffice at `http://localhost:3000/admin`. +at `http://localhost:3000/swagger-config` and the back-office at `http://localhost:3000/admin`. ## Development mode -You also need a [ngrok](https://ngrok.com/) host for the external host in `tdm-be/config/devlopement.json`, +You also need a [ngrok](https://ngrok.com/) host for the external host in `tdm-be/config/development.json`, to create a ngrok endpoints run `ngrok http 3000`. After setting up this you can run `make run-dev` diff --git a/tdm-admin/README.md b/tdm-admin/README.md index 2c2e76b..92a557c 100644 --- a/tdm-admin/README.md +++ b/tdm-admin/README.md @@ -1,6 +1,6 @@ # TDM Backoffice React.js Application -This project is a React.js application built to provide TDM backoffice. +This project is a React.js application built to provide TDM back-office. ## Getting Started @@ -49,7 +49,7 @@ The project structure is organized as follows: - `src/`: Contains the source code of the React application. - `index.tsx`: entry point - - `app/`: + - `app/`: - `components/`: Reusable UI components. - `page/`: Individual application page - `services/`: Application network tools diff --git a/tdm-be/README.md b/tdm-be/README.md index 9de07be..3a9f209 100644 --- a/tdm-be/README.md +++ b/tdm-be/README.md @@ -48,7 +48,7 @@ The project structure is organized as follows: - `config/`: Contains application config files - `crash/`: Contains crash reports. - `logs/`: Contains logs. -- `public/`: Contains serv HTML and files. +- `public/`: Contains server HTML and files. - `tmp/`: Contains temporary files. - `upload/`: Contains uploaded files. - `src/`: Contains the source code of the Express application. diff --git a/tdm-fe/README.md b/tdm-fe/README.md index 375da2d..1149e60 100644 --- a/tdm-fe/README.md +++ b/tdm-fe/README.md @@ -49,7 +49,7 @@ The project structure is organized as follows: - `public/`: Contains the public assets, HTML template, and favicon. - `src/`: Contains the source code of the React application. - - `app/`: + - `app/`: - `components/`: Reusable UI components. - `globals.css`: Global CSS of the application. - `page.tsx`: Main component where components are assembled.