harshit1698 / creativecommons.github.io-source

Source files for CC Open Source website

creativecommons.github.io-source

Source for creativecommons.github.io

⚠️ DO NOT MAKE CHANGES TO THE creativecommons.github.io REPO DIRECTLY.

Overview

This site is built using Lektor. All changes to https://creativecommons.github.io must be made here and deployed via lektor (see Deployment, below).

Installation

1. Make sure you have pipenv installed.
2. Clone this repository.
3. Open your command line interface and cd to the repository root directory.
4. Run pipenv install to create a Python virtual environment and install the requirements for this project.

pipenv Troubleshooting

pipenv doesn't always provide the best error messages (Provide better error message if the project’s virtual environment is broken). If all else fails, try removing the virtual environment and reinstalling:

1. pipenv --rm
2. pipenv install

Development

1. Run pipenv shell to spawn a shell with the virtualenv activated.
2. Run lektor server -f webpack to start the Lektor development server. You will be able to see the website at http://localhost:5000/. The Lektor server will rebuild the site every time you change any content.

Deployment

We have continuous deployment set up. To deploy, push your code to the master branch (or make a pull request against the master branch. Travis CI builds and deploys the site whenever it detects new commits on the master branch.

Manual Deployment

For reference only, you should not need to not do this.

When you are ready to deploy a new version of the site, run lektor deploy (assuming you have your GitHub SSH key already set up and you have access to the creativecommons.github.io repository). That's it, it's live on production!

Project Structure

Here's how the code is structured in the top level of the repository:

• assets: This directory contains the JavaScript and CSS files for the project built via webpack. Most of the JavaScript and CSS is third-party code and loaded via CDN so this is pretty empty.
• content: The content of the site lives here. Here's an explanation of how content works in Lektor. This is probably what you'll be modifying most often.
• models: All content in Lektor is associated with data models to define their schema. Currently, we only use the default page model that ships with Lektor.
• templates: This is where the Jinja2 templates that render content are stored. See the Lektor template documentation for more information.
• webpack: This is where all the webpack config files as well as Sass and JavaScript files for the project resides. The JavaScript and Sass files are compiled and saved in assets folder during lektor build process.

Redirects

• /cc-vocabulary/ to https://cc-vocabulary.netlify.com/
  • Added so that the opensource.creativecommons.org/cc-vocabulary/ will continue to work with that project moving to utilize Netlify.
• /cc-vue-vocabulary to https://cc-vue-vocabulary.netlify.com/
  • Added so that the opensource.creativecommons.org/cc-vue-vocabulary/ will continue to work with that project moving to utilize Netlify.
• /cc-fonts to https://cc-fonts.netlify.com/
  • Added so that the opensource.creativecommons.org/cc-fonts/ will continue to work with that project moving to utilize Netlify.

License

• LICENSE (Expat/MIT License)