You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-16Lines changed: 20 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
1
## [Trello](https://trello.com) Integration with [Habitica](https://habitica.com)
2
+
2
3
This Power-Up([?](https://trello.com/en/guide/power-up-productivity)) will keep your Trello cards in sync with Habitica. **No coding is required**; just fill in the form and you're all set!
3
4
4
5
## How to use?
6
+
5
7
Each Power-Up is associated with a team. Once a Power-Up has been added to a team, it will be available to all of the boards that belong to that team. So [create a team](https://trello.com/en/guide/create-a-team.html) if you don't have one.
6
8
7
9
To add a new Power-Up to your team, navigate to the [Power-Ups Administration page](https://trello.com/power-ups/admin), choose your team and click **Create a Power-Up**.
@@ -10,16 +12,20 @@ Now it's time to fill in the form.
10
12
11
13
1. First, name your Power-Up.
12
14
2. To work properly this Power-Up requires some permissions. Make sure you've checked all of the following:
13
-
* board-buttons
14
-
* callback
15
-
* card-badges
16
-
* card-buttons
17
-
* card-detail-badges
18
-
* list-actions
15
+
16
+
- board-buttons
17
+
- callback
18
+
- card-badges
19
+
- card-buttons
20
+
- card-detail-badges
21
+
- list-actions
22
+
19
23
3. Provide the URL to your Power-Up.
20
-
* The easiest way is to use the url provided below. As a bonus you will receive all upcoming updates without any changes from your side.
21
-
`https://alexktzk.github.io/trello-habitica`
22
-
* Or you can fork this repository, publish **gh-pages** branch to [GitHub Pages](https://pages.github.com) and use your own url.
24
+
25
+
- The easiest way is to use the url provided below. As a bonus you will receive all upcoming updates without any changes from your side.
26
+
`https://alexktzk.github.io/trello-habitica`
27
+
- Or you can fork this repository, publish **gh-pages** branch to [GitHub Pages](https://pages.github.com) and use your own url.
28
+
23
29
4. Now you can navigate to one of the boards of the team and activate your Power-Up! You will find it in the **Custom** section.
24
30
5. Finally, click the list menu (three dots) and select either "Mark list as Doing" or "Mark list as Done."
25
31
@@ -42,17 +48,17 @@ $ npm install
42
48
43
49
### Run
44
50
45
-
For quick start run:
51
+
For quick start run
46
52
47
53
```
48
54
$ npm start
49
55
```
50
56
51
-
It will build the project and run[webpack-dev-server](https://webpack.js.org/configuration/dev-server/) to watch and update when any of the files are changed.
57
+
It builds the project and runs[webpack-dev-server](https://webpack.js.org/configuration/dev-server/) to watch and update when any of the files are changed.
52
58
53
59
### Live testing
54
60
55
-
In order to test your code directly on the Trello board you should obtain a public url that points to your local web server. I prefer to use [serveo](https://serveo.net/) in this case.
61
+
In order to test your code directly on a Trello board you should obtain a public url that points to your local web server. I prefer to use [serveo](https://serveo.net/) in this case.
56
62
57
63
```
58
64
$ ssh -R 80:localhost:8080 serveo.net
@@ -76,8 +82,6 @@ Once you've done just grab your public url and pass it to the Power-Up form as *
76
82
$ npm run deploy
77
83
```
78
84
79
-
It will create a build from the **master** branch and push it to [Github Pages](<https://pages.github.com/>).
80
-
81
-
## Contributing
85
+
That's it, you're live. Try to check your repo's [Github Pages](https://pages.github.com/) url.
82
86
83
-
Feel free to contribute!
87
+
The script generates and pushes the **dist** folder to **gh-pages**. For this, it creates and switches branches under the hood. Therefore, if you have any uncommited changes it will fail to run.
0 commit comments