If you are readinng this document it means that:
- you are watching codebase
- you want to contribute with a PR
This small document want to help you to undestand how project is structured
src
: all typescript files used to build the librarysrc/client
: contains both server side (express) and client side (react) apps.dist
outputplayground
: we can use this folder to prototype new feature and test in realt time. By defaultdev server
point to this folder.example
. it is generated by"marilena --create-example"
. It should remain working and without edits.test
. contains jest test for all usescase of librarycypress
. contains test for the web app
The 2 goals of this project:
- project need to provide a working
"marilena --server"
to open a server and used for diplay the rendered output - project need to provide a working
"marilena --build"
to take all emails and create the output - point 1 and point 2 share some methods.
- study project structure
- use playground (os create a copy)
- add test with snapshot if fix/feature are regarding an email output
- add a test anyway :)
- add cypress test if you think that changes are regarding playground