-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5756308
commit c2483fc
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Contributing | ||
|
||
## Frontend | ||
|
||
Unlike many Django developers who like to write client side code in template, I prefer to put them in a `*.js` files and Stimulus JS is my favorite to write **reusable** and **maintainable** JavaScript code. | ||
|
||
```bash | ||
$ npm install | ||
|
||
# launch webpack to compile the frontend assets and put them in `src/django_lookbook/static` | ||
$ npm run watch | ||
``` | ||
|
||
## Backend | ||
|
||
```bash | ||
# install the package in editable mode | ||
$ pip install -e . | ||
``` | ||
|
||
Notes: | ||
|
||
1. Then you can install it in your Django project and debug it. | ||
2. Or you can run the tests with `pytest`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,4 @@ Topics | |
|
||
install.md | ||
write_preview.md | ||
contributing.md |