mirror/lowdefy
2
0
Fork 0
mirror of https://github.com/lowdefy/lowdefy.git synced 2024-11-21 01:14:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add dev script instructions to contributing sections.

Browse Source
This commit is contained in:
Gervwyk 2022-01-24 09:35:00 +02:00
parent 9a033dc2f8
commit c737cb3d78
2 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -1,5 +1,6 @@
# Lowdefy Contributor Guide
- [Starting the Lowdefy server](#starting-the-lowdefy-server)
- [Asking a question](#asking-a-question)
- [Reporting bugs](#reporting-bugs)
- [Suggesting features](#suggesting-features)
@ -7,6 +8,16 @@
- [Responding to questions](#responding-to-questions)
- [Contributing code](#contributing-code)
## Starting the Lowdefy server
Run Lowdefy servers locally by adding your Lowdefy config to the `app/..` folder. Use one of the following scripts to the server:
- `yarn start`: Starts the production server.
- `yarn start:dev`: Starts the production server in next development mode, useful for debugging Lowdefy code changes.
- `yarn start:server-dev`: Starts the development server in next production mode, useful for developing your Lowdefy config locally.
> `yarn install` and `yarn build` should be executed manually during development, this allows you to build only the package you are working on. Server needs to be restarted after package rebuild.
## Asking a question
If you aren't sure how something works, or you are stuck with something, ask a question in our [Community forum](https://github.com/lowdefy/lowdefy/discussions). This will help others with the same questions, and help us improve.

10
README.md
View File

@ -102,7 +102,15 @@ All changes to this project are documented in [CHANGELOG.md](https://github.com/
## Contributing
Please see [CONTRIBUTING.md](https://github.com/lowdefy/lowdefy/blob/main/CONTRIBUTING.md).
Run Lowdefy servers locally by adding your Lowdefy config to the `app/..` folder. Use one of the following scripts to the server:
- `yarn start`: Starts the production server.
- `yarn start:dev`: Starts the production server in next development mode, useful for debugging Lowdefy code changes.
- `yarn start:server-dev`: Starts the development server in next production mode, useful for developing your Lowdefy config locally.
> `yarn install` and `yarn build` should be executed manually during development, this allows you to build only the package you are working on. Server needs to be restarted after package rebuild.
Please also see [CONTRIBUTING.md](https://github.com/lowdefy/lowdefy/blob/main/CONTRIBUTING.md).
## Security