Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README #264

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update README #264

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68205fa
Add step to build compare page to Quick Start Guide
mikeubell May 26, 2023
a1b7ad1
Update README.md
mikeubell May 26, 2023
8f45b1f
Add version for Node
mikeubell May 26, 2023
434614f
docker-compose -> docker compose
mikeubell May 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Some of the other Issues are larger and require some deeper design or architectu
1. While still in the root directory of the repo, create a new folder called "build". This folder will be ignored by our version control system.
1. Navigate to the \_src/ folder, which is where all development work takes place.
1. Install dependencies with `npm install`
1. Serve the website by entering `npx @11ty/eleventy --serve --port=8011`
1. Run `yarn run watch` (see Instructions for Compare Page, below)
3. Serve the website by entering `npx @11ty/eleventy --serve --port=8011`

Congratulations! Your local copy of Open Budget Oakland's website should now be running at http://localhost:8011. That means you're ready to do the codez if you want to contribute to the codebase of Open Budget Oakland. You will probably want to open a new terminal window, though, to regain access to the command line.

Expand All @@ -27,8 +28,9 @@ This site is built with [Eleventy](https://11ty.dev), a JavaScript-based static

You'll need these installed globally:

- [Node](http://nodejs.org/download/) is a prerequisite for NPM
- [NPM](https://npmjs.com) or [Yarn](https://yarnpkg.com/en/)
- [Node](http://nodejs.org/download/) v15.14.0 is a prerequisite for NPM
- [NPM](https://npmjs.com)
- [Yarn](https://yarnpkg.com/en/) for the Comparison page
- [NVM](https://github.com/nvm-sh/nvm/blob/master/README.md) is optional, but very handy for downloading, updating, and switching between versions of NPM

### Install & Run Eleventy in \_src/
Expand Down Expand Up @@ -119,7 +121,7 @@ The WordPress plugin (OBO Custom Routes) that generates our API can be installed

To develop new features for the API, you may want to run Wordpress locally.
This repo includes a configuration file for doing so with [Docker Compose](https://docs.docker.com/compose/).
With Docker Compose installed, simply run `docker-compose up` in `wordpress plugin for custom API endpoints/`
With Docker Compose installed, simply run `docker compose up` in `wordpress plugin for custom API endpoints/`
to activate linked containers for Wordpress, MySQL, and PhpMyAdmin. The Wordpress container will
mount that directory as though it were Wordpress' `plugins/` directory, allowing your edits to
the plugin files in `obo_custom_routes/` to be reflected in your Wordpress instance. (Additional plugins that
Expand Down