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
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@
3
3
The Creative Commons License Chooser is meant to help people learn about CC licenses, and select the license that best fits their needs. The new version in this repo places greater importance on usability, and an educational experience of the six CC licenses.
4
4
5
5
## About
6
+
6
7
Repository containing the source code for the new Creative Commons License Chooser. The new chooser is still in beta, and a beta deployment can be found [here](https://chooser-beta.creativecommons.org/).
7
8
8
9
This site is built using [Vue.js](https://vuejs.org/) (and vue-cli).
@@ -12,6 +13,7 @@ This site is built using [Vue.js](https://vuejs.org/) (and vue-cli).
12
13
Tasks, issues, and discussion related to the release of the new chooser are tracked with the [`Launch Milestone`](https://github.com/creativecommons/chooser/milestone/1).
13
14
14
15
## Getting Started
16
+
15
17
Run the following commands in order to have the code up and running on your machine:
16
18
17
19
```bash
@@ -24,6 +26,7 @@ $ npm run serve
24
26
You should now have the application running and accessible at http://localhost:8080 (note: will run on a different port if 8080 is occupied, most common alternative port is 8081).
25
27
26
28
## Contributing
29
+
27
30
For information on contributing, please see [Creative Commons' Contribution Guidelines](https://opensource.creativecommons.org/contributing-code/)
28
31
29
32
If you create a PR for your work, but you are not finished yet, please include `WIP:` in the beginning of your PR title. When your work on your PR is completed, and you are ready for a final review, please remove the `WIP:` prefix from the title to indicate that your work is done.
@@ -35,16 +38,27 @@ If it says "No results matched your search", then there are no issues currently
35
38
*If no progress has been made on an issue for seven days after assignment, the assignment will be removed to allow others to contribute.*
36
39
37
40
## Running Tests
41
+
38
42
You can run tests by executing:
39
43
40
44
```bash
41
45
$ npm run test
42
46
```
43
47
44
48
## CSS Build
49
+
45
50
The Chooser uses PostCSS plugin for PurgeCSS to make CSS bundle size smaller. It automatically removes unused CSS based on the classes found in the final built bundle. Some styles for dynamic components or dynamically-imported files can also be removed. If you find that the built site misses some styles, you can manually add the necessary classes or Regex expressions to the `safelist` array in the `postcss.config.js` file.
46
51
47
52
## Deployment
53
+
48
54
The chooser is deployed to GitHub Pages. The source files for the beta deployment are contained in the `./docs/` dir, and are live. Any changes to this directory's contents will be automatically deployed, so please take care when making modifications to this location.
49
55
50
56
To update the dist bundle, run ```$ npm run build```. This will also automatically copy the generated files from `./dist/` to `./docs/`.
57
+
58
+
## Output Modes
59
+
60
+
The site can be built in two different modes: `embedded` and `standalone`. `Embedded` mode removes the header and foter from the application, resulting in the following appearance:
61
+
62
+
<imgsrc="static/embedded-screenshot.png"alt="Application built in embedded mode">
63
+
64
+
To build into embedded mode, set the environment variable `VUE_APP_CC_OUTPUT=embedded` on your server before building. If `VUE_APP_CC_OUTPUT` is unset or set to a different value, the app will build in the default `standalone` mode, with its own header and footer.
0 commit comments