Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.02 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.02 KB

🛤 Embark

Embark is a series of tools for bootstrapping a project for the deft platform and workflow.

Embark will help template a new project and will setup development lifecycle scripts for that project. Regardless of the underlying tech stack, embark uses similar scripts for each workflow regardless of the underlying technology.

Embark uses idempotent scripts for bootstrap and update. Once these have run they will noop if there is nothing to do. This requires all of the functions that power these lifecycles to check before working.

Embark uses PIDS in ./tmp/process.pid and logs at ./logs/development.log for services.

Soon™

Embark will be checked via a nightly build to ensure that all the lifecycle hooks still work for new projects supported by the Spaceship Platform.

Projects bootstrapped with embark will run nightly builds on the Spaceship Platform to ensure that the project onboarding workflow continues to work for new team members joining the project. Gone are the days of out of date READMEs and artisinal environments.

Get Started

TODO

Lifecycle scripts

bin/bootstrap installs all of necessary environment dependencies and runs any one-off setup.

bin/update installs new library dependencies, migrates all of the datastores, and seeds any datastores.

bin/cibuild runs a cibuild

bin/server starts the server

bin/console starts a REPL console for the project

Where can I get more help, if I need it?

TODO

Contributors

License

Apache License 2.0

Acknowledgements