Documentation coming soon...
yarn
yarn build
yarn docker:up
(You will be able to stop the docker compose with yarn docker:down
)
yarn dev
The application is available on localhost:3000
Login with
- Email: admin
- Password: admin
A catch all mailbox is available on localhost:1080
- 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
yarn docs:dev
yarn docs:dev:build
yarn docs:api
yarn docs:api:build
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
GPL-3.0