mirror/Compass
1
0
Fork 0
mirror of https://github.com/CompassConnections/Compass.git synced 2026-04-04 06:51:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update readme info

Browse Source
This commit is contained in:
MartinBraquet
2025-09-16 15:13:36 +02:00
parent d7e6a41e3f
commit 4919240242
1 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
backend/email/README.md
View File

@@ -7,17 +7,31 @@ A live preview right in your browser so you don't need to keep sending real emai
First, install the dependencies:
```sh
npm install
# or
yarn
yarn install
```
Then, run the development server:
```sh
npm run dev
# or
yarn dev
```
Open [localhost:3000](http://localhost:3000) with your browser to see the result.
Open [localhost:3001](http://localhost:3001) with your browser to see the result.
### Notes
Right now, I can't make the email server run without breaking the backend API and web, as they require different versions of react.
To run the email server, temporarily install the deps in this folder. They require react 19.
```bash
yarn add -D @react-email/preview-server react-email
```
When you are done, reinstall react 18.2 by running `yarn clean-install` at the root so that you can run the backend and web servers again.
## Useful commands
```bash
```