Skip to content
[WIP] The new and improved CC license selection tool.
JavaScript Vue Other
Branch: master
Clone or download

README.md

chooser

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.

About

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.

This site is built using Vue.js (and vue-cli), and Buefy, among other things.

Roadmap

Tasks, issues, and discussion related to the release of the new chooser are tracked with the Launch Milestone.

Getting Started

Run the following commands in order to have the code up and running on your machine:

# installs dependencies
$ npm install

# Builds and serves assets with hot-reload
$ npm run serve

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).

Contributing

For information on contributing, please see Creative Commons' Contribution Guidelines

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.

Here's a handy link that will show you all open issues in this repo that have the help wanted tag, but do not have the in progress tag. All issues in this list are up for grabs! If it says "No results matched your search", then there are no issues currently up for grabs.

If no progress has been made on an issue for seven days after assignment, the assignment will be removed to allow others to contribute.

Running Tests

You can run tests by executing:

$ npm run test

To run e2e tests, you must have Java installed. [download Java here]

Deployment

The source files for the beta deployment are contained in the ./docs/ dir, and are live. Any changes to this dir's contents will be automatically deployed, so please take care when making modifications to this location.

To update the dist bundle, run $ npm run build, and copy the generated files from ./dist/ to ./docs/, taking care to not delete the CNAME file in ./docs/.

You can’t perform that action at this time.