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
+24-11Lines changed: 24 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,22 @@
4
4
5
5
This template is for creating a website to track designs created by a UXD team. Built on Jekyll using GitHub pages, this template will enable you to quickly get up and running with a basic set of sortable and filterable tables, patterns for adding designs links and sharing stories from any issue tracking system.
6
6
7
-
View the [Changelog]()
7
+
View the [Changelog](CHANGELOG.md)
8
8
9
-
----
9
+
View the [Wiki](https://github.com/rh-uxd/design-tracker-template/wiki)
10
10
11
-
## Local Development
12
-
Run the environment locally using the steps below:
11
+
---
12
+
13
+
## Installation
14
+
15
+
| This installation requires that you have Ruby, Node, Gem, Jekyll and Gulp installed. You can find a list of dependecies with versions here: [Design Tracker Dependencies](https://github.com/rh-uxd/design-tracker-template/wiki/Dependencies)
16
+
17
+
1. Fork this repository
18
+
1. Rename as desired (we recommend with UX in the name)
19
+
1. Clone to your local machine
20
+
1. With Node, Gulp, Ruby, Gem and Jekyll already installed, run `npm run initialize`
21
+
1. Start with `jekyll serve`
22
+
1. Code away!
13
23
14
24
### First Time Build
15
25
1. Verify that you have the following installed:
@@ -28,16 +38,19 @@ Run the environment locally using the steps below:
28
38
- for viewing locally at http://localhost:4000
29
39
30
40
### Subsequent Builds
31
-
1.Run the npm command `npm run site`
41
+
1.`jekyll serve` to start your environment on port `:4000`.
32
42
33
43
### Troubleshooting
34
-
If you are having issues with the site building, you can run two sets of clean commands:
44
+
If you are having issues with the site building, you can run a set of cleaning commands to reset your environment.
35
45
46
+
#### Environment Troubles
47
+
-`npm run reinstall`
48
+
- This will clear out your **node_modules** folder, any vendor folders, reinstall all modules and copy vendor files back to their respective locations.
36
49
-`gulp cleanVendors`
37
-
- This will remove the vendor files that were copied over during the `gulp` process
38
-
-`npm run clean`
39
-
- This will remove your node_modules directory, run `npm install`, run `gulp cleanVendors` to remove any old vendor files, and run `gulp` to copy updated vendor files.
50
+
- This will remove just the vendor files that were copied over during the `gulp` process.
51
+
- Run `gulp` to copy a clean set of vendor files back to your directories.
40
52
53
+
#### Gem Issues
41
54
If you have issues with your gem bundles, you can run the following command:
42
-
-`npm run bundle`
43
-
- This will update the gem bundles. If you do not have node installed, just run `bundle update`.
55
+
-`bundle update`
56
+
- This will check for any updates to your gem bundles, cleaning old bundles.
0 commit comments