Skip to content

LePatron is an opensource email builder allowing to industrialize your email template production. Build tailor made email templates and make them available to your non-technical users.

License

Notifications You must be signed in to change notification settings

Badsender-com/LePatron.email

Repository files navigation

✉️ LePatron.email

Open Source Email Builder


🚀 Deploy on the Cloud

Documentation coming soon...


Run locally

1. Install dependencies

yarn
yarn build

2. Run the database

yarn docker:up

(You will be able to stop the docker compose with yarn docker:down)

3. Run the application

yarn dev

The application is available on localhost:3000

Login with

  • Email: admin
  • Password: admin

A catch all mailbox is available on localhost:1080

Access to the database

  • You need MongoDB on your computer. If you haven't, you can install MongoDB Compass
  • Install the version you need
  • In a shell terminal, launch the following commands:
docker ps # Check if your database docker container is launched
docker exec -it lepatron_mongo_container bash # Run command prompt on your docker container
mongo # To see the mongo connection name
  • The connection name looks something like mongodb:https://127.0.0.1:27017/?compressors=disabled&gssapiServiceName=mongodb
  • Remove all the queries parameters to have : mongodb:https://127.0.0.1:27017/
  • Paste it in MongoDB Compass UI
  • You have access to your database

Generate documentation

Run application documentation

yarn docs:dev

Build application documentation

yarn docs:dev:build

Run API documentation

yarn docs:api

Build API documentation

yarn docs:api:build

Troubleshooting

If you encounter this error during documentation generation :

(node:24453) UnhandledPromiseRejectionWarning: Error: EACCES: permission denied, scandir '.../.mongodb/diagnostic.data'

Simply give access to .mongodb folder to your user :

chown $(whoami):$(whoami) -R ./.mongodb

License

GPL-3.0