Open source email builder
Report Bug
·
Request Feature
LePatron is an email builder allowing to industrialize your email template production. Build tailor made email templates and make them available to your non-technical users.
To get a local copy up and running follow these simple steps.
You will need the following tools to be able to run the project locally:
Clone the repo
git clone https://github.com/Badsender-com/LePatron.email.git
Install NPM packages
yarn
yarn build
Run the local database
yarn docker:up
(You will be able to stop the docker compose with yarn docker:down
)
Run the application
yarn dev
The application is available on localhost:3000
Login with
A catch all mailbox is available on localhost:1080
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
mongodb://127.0.0.1:27017/?compressors=disabled&gssapiServiceName=mongodb
mongodb://127.0.0.1:27017/
yarn docs:dev
yarn docs:dev:build
yarn docs:api
yarn docs:api:build
When you open a feature / fix PR, make sure to include tests that covers this feature.
Units tests are written using the jest testing framework.
yarn test # run tests in watch mode, usefull when developing
yarn test-ci # run all tests, no watch. Mainly used in the CI
Instructions on how to deploy on Heroku and CleverCloud are provided in the readme file.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
git checkout -b feat/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feat/AmazingFeature
)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
Distributed under the GPL-3.0 License. See LICENSE
for more information.
Project Link: https://lepatron.email/