Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-yin committed Jun 3, 2024
1 parent 4722f9b commit ac97183
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/source/contributing.md
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`.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Topics

install.md
write_preview.md
contributing.md

0 comments on commit ac97183

Please sign in to comment.