Overview

The purpose of the Shift/Pedalpalooza Calendar is to empower citizens to create and view bike events and to spread bike fun.

Software

built using:

• php
• docker
• hugo v0.37.1
• && the theme "Universal"
• && the content from the legacy shift website
• && Netlify web hosting to serve the content
• && the Netlify CMS

You can see the live site here: https://www.shift2bikes.org

Contributing

• If you want to change something about the site configuration or theme, pull requests are welcome. Once you create a PR, you can immediately check out a link to the build status and log and a preview of your changes.
• If you only want to edit CONTENT rather than any code or site styling, (including creating new pages), this doc shows how to easily do so without writing code.

Local development

Following the below steps you'll have a copy of the site running, including 3 docker containers running nginx, db, and the php server:

1. install docker: https://docs.docker.com/get-docker/
2. download source code: git clone https://github.com/shift-org/shift-docs.git
3. download additional external modules: cd shift-docs ; git submodule update --init --recursive
4. start shift site: ./shift up
5. visit https://localhost:4443/ . If this leads to an SSL error in chrome, you may try flipping this flag: chrome://flags/#allow-insecure-localhost

Note that no changes to the filesystems INSIDE the container should ever be needed; they read from your LOCAL filesystem so updating the local FS will show up in the container (perhaps after a restart). Updating, changing branches, etc can be done with git commands OUTIDE of the container (git checkout otherbranch or git pull).

Netlify deployment

You can easily run your own copy of the site with these two steps. This could help you do things like theme development, in your own repository, before submitting your finished write-up to us for incorporation.

1. fork repo
2. deploy on Netlify by linking your forked repo. Included configuration file netlify.toml should mean 0 additional configuration required to get the site running.

If you have trouble with it please file an issue to let us know what you tried and what happened when you did.

License

This repository is under MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Development Overview

The site is run in several docker containers.

Important Project Files

• docker-compose.yml

  • docker container settings

  • The defined containers (db, nginx, etc) become pingable host names from the other running containers. For example, attached to the nginx container, you can "ping db"

  • Contains the container specific mappings between host and docker container persistent volumes for example for the node container:

    volumes:

    • ./borzoi/node/:/opt/borzoi/node/
    • ./app:/home/node/app

• shift

  • This is the convenience wrapper that sets up the environment and has various convenience sub-commands to connect to the environment and manipulate it as well. This is how you'll start the project, connect to the database, etc!
  • contains environment variables that get loaded and are then available for docker to import. Docker environment variables that will be important are defined separately for each container (see: docker-compose.yml). Run env inside an attached docker container to see the variables that made it into the running container.

• secrets and secrets.override

  • these are the credentials to connect to your local instance. You should change them if you host your site allowing public connections!

• shift.overrides and shift.overrides.production

  • these are the local (potential) configuration overrides, that aren't secret

Shift subcommands of interest

• ./shift attach node
  • node is a reference to the named docker container. Note that you want just nginx, db or php not the full image name (shift_nginx_1)
  • Attaches to the running docker container in the shift stack
• ./shift up
  • If necessary, first builds, and then starts up the docker containers (will also restart if run while the environment is already running.)
• ./shift logs nginx
  • Will start tailing the logs for the specified container (nginx in this case)
  • multiple container names can be mentioned
• ./shift down
  • stops the docker containers

Docker Daemon commands of interest

• docker ps
  • lists all of the running process and port information from docker (ex: you can see the postgres service port)
• docker volume ls
  • This will show the persistent volumes that docker knows about. The shift project volumes are prefixed with shift_
  • The "shift_" docker namespace comes from the shift file: export COMPOSE_PROJECT_NAME="shift"

Sequalize Setup

(fool doesn't think we're using this in 2021! It does not seem to be required these days.)

npm install --save pg pg-hstore
bash npm install --save sequelize

(from: http://docs.sequelizejs.com/manual/installation/getting-started.html)

c-c-c-cache buster