8000 update contrib docs · torchbox/django-pattern-library@9dd51c9 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9dd51c9

Browse files
nickmoretonthibaudcolas
authored andcommitted
update contrib docs
1 parent ad00f7e commit 9dd51c9

File tree

2 files changed

+10
-15
lines changed

2 files changed

+10
-15
lines changed

.gitpod.yml

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,16 @@ tasks:
1515
clear
1616
nvm install
1717
npm install
18-
command: npm run start
18+
command: npm run build
1919
name: Node
2020
openMode: split-right
2121
2222
- init: |
2323
clear
24+
echo "Waiting for python..."
2425
gp sync-await python
25-
command: poetry run ./runtests.py
26+
command: |
27+
poetry run ./runtests.py
28+
poetry run django-admin render_patterns --settings=tests.settings.dev --pythonpath=.
2629
name: Tests
2730
openMode: split-right
28-
29-
- init: |
30-
clear
31-
command: |
32-
echo "There are 3 terminals ready to use"
33-
echo "1. Runserver: is running the django dev-server on http://127.0.0.1:8000"
34-
echo "2. Tests: will run the tests once and wait for 'poetry run ./runtests.py' to run the tests again"
35-
echo "3. Node: will run 'npm run start' and watch files for changes"
36-
echo "4. Bash: is this terminal and can be use to run other adhoc commands"
37-
echo "Try out the render_patterns command: 'poetry run django-admin render_patterns --settings=tests.settings.dev --pythonpath=.' and look in the 'dpl-rendered-patterns' folder"
38-
openMode: tab-after

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
This document contains information for anyone wishing to contribute to the project.
44

55

6-
76
## Installation
87

9-
The repo includes a simple test application that can be run locally to develop the pattern library itself.
8+
The repo includes a simple test application that can be run to develop the pattern library itself.
9+
10+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/torchbox/django-pattern-library) *Using the [Poetry setup](#run-locally-with-poetry)*
11+
12+
### Or run locally
1013

1114
First, clone the repo:
1215

0 commit comments

Comments
 (0)
0