mirror of
https://github.com/mudita/mudita-center.git
synced 2025-12-23 22:28:03 -05:00
Add scripts manual (or at least the initial version)
This commit is contained in:
@@ -26,6 +26,7 @@ If you would like to help us create Mudita Center as a full-time job - **[we're
|
||||
## Table of contents
|
||||
|
||||
- [Quickstart](#Quickstart)
|
||||
- [Scripts](#Scripts)
|
||||
- [Contributing](#Contributing)
|
||||
- [Discussions](#Discussions)
|
||||
- [Reporting issues and feature requests](#Reporting-bugs-and-feature-requests)
|
||||
@@ -36,6 +37,10 @@ If you would like to help us create Mudita Center as a full-time job - **[we're
|
||||
|
||||
You can quickstart the project by going through the ["Quickstart" article](./quickstart.md).
|
||||
|
||||
## Scripts
|
||||
|
||||
Take a look at the list of available npm [Scripts](./SCRIPTS.md).
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests are welcome. Please follow the guidelines in the ["Contributing to Mudita Center"](./CONTRIBUTING.md) article. Before contributing or starting a discussion, please make sure that you read our [Code of Conduct](./CODE_OF_CONDUCT.md).
|
||||
|
||||
27
SCRIPTS.md
Normal file
27
SCRIPTS.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Scripts manual
|
||||
|
||||
## About
|
||||
|
||||
This document explains different scripts available in the `package.json`.
|
||||
It's split by the package and the root repo.
|
||||
|
||||
## Projects
|
||||
|
||||
### Root
|
||||
|
||||
#### setup
|
||||
|
||||
Used to set up the project locally. Does both `npm install` and `lerna bootstrap` for you.
|
||||
When you start the project, it's the call you want to run.
|
||||
|
||||
#### boostrap:local
|
||||
|
||||
Bootstraps the packages locally for use with Lerna. It's the dev time task only.
|
||||
|
||||
#### bootstrap:ci
|
||||
|
||||
The CI bootstrap routine. USed for GitHub workflows.
|
||||
|
||||
#### bootstrap:netlify
|
||||
|
||||
The Netlify bootstrap routine. Only for Netlify's need.
|
||||
Reference in New Issue
Block a user