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
+39-9Lines changed: 39 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,22 +54,52 @@ Once changes are implemented here, they need to be updated within the `/chooser`
54
54
Final production changes are deployed within vocabulary-theme Releases, updated within [`index-dev-env`][index-dev-env], and finally deployed to `index__stage` and then `index__prod` environments; going LIVE at `https://creativecommons.org/chooser`.
55
55
56
56
57
-
## Setup
58
-
1. open the `src/index.html` file within a browser to view the Chooser.
For information on learning and installing the prerequisite technologies for this project, please see [Foundational technologies — Creative Commons Open Source][found-tech].
Use the following instructions to start the Project with docker compose.
66
+
67
+
1. Navigate to the creativecommons/chooser Project that you have cloned
68
+
2.**Run the containers**
69
+
70
+
```shell
71
+
docker compose up
72
+
```
73
+
74
+
3. After running the above command, Docker will use the `docker-compose.yml` file and Build a local environment for you
75
+
4. Navigate to http://localhost:8080 in your browser and the app would be running.
76
+
5.**stop the containers**
77
+
78
+
To stop the app from running, simply open an another instance of terminal and type:
79
+
80
+
```shell
81
+
docker compose down
82
+
```
83
+
84
+
or
85
+
86
+
You can simply revisit the existing terminal which is running the container
87
+
and type `CTRL + C`
88
+
89
+
90
+
### Format with Prettier
91
+
92
+
Run the following command to format files with Prettier:
93
+
94
+
```shell
95
+
docker compose exec node prettier --write src/
96
+
```
67
97
68
98
## Structure
69
99
70
100
The initial markup is rendered via the `index.html` file. Visual display is derived from the `style.css` rules. Styles extend from `src/vocabulary`.
71
101
72
-
On initlialization the `scripts.js` functions set the correct fieldsets to default display; based on user provided actions through the stepper fieldsets will display or hide, exposing the relevant pathways to getting a `tool` recommendation. Correct pathways are located within the `rawStatePathRoutes` array. When a correct pathway matches the current `state`, the appropriate `tool` is matched and recommended, if the current state is not a known pathway the `tool` is set to `unknown` until the required input is given.
102
+
On initialization the `scripts.js` functions set the correct fieldsets to default display; based on user provided actions through the stepper fieldsets will display or hide, exposing the relevant pathways to getting a `tool` recommendation. Correct pathways are located within the `rawStatePathRoutes` array. When a correct pathway matches the current `state`, the appropriate `tool` is matched and recommended, if the current state is not a known pathway the `tool` is set to `unknown` until the required input is given.
73
103
74
104
The main `tool` recommendation content is pulled via the appropriate `<template>` markup located within HTML. Additional information for the marking formats is also sourced from these `<template>` elements and the contents of the `Attribution Details` fields.
0 commit comments