Welcome to the Github repository for The Political Revolution's Wordpress setup. It is built upon the Sage 8.5 starter theme and sports a modern development workflow.
This file describes the steps to install this Wordpress repo and setup all the components on the same (Debian or Ubuntu) machine. The steps should be largely similar for using MAMP or homebrew.
Contributions are welcome from everyone. However, please read the contributing guidelines before jumping into the code to give your work the highest chance of being merged.
Make sure all dependencies have been installed before moving on:
- Node.js >= 4.5
- update to the latest version of npm:
npm install -g npm@latest.
- update to the latest version of npm:
- Docker Engine for your platform
Installation is straight-foward.
- Clone the repository.
- Install gulp and Bower globally with
npm install -g gulp bower - In the root of the project, run
npm run-script build && npm start. - Navigate to http://localhost:8080/ and follow the instructions to create your local dev environment.
npm start runs gulp watch and starts the docker development server. Stopping gulp with ctrl + C and running npm stop will spin down your dev processes. To attach to the terminal of the local dev server, you may run docker exec -it wpthepoliticalrevorg_my-wp_1 /bin/bash.
A pre-populated database is not currently being provided. However, after setting up Wordpress for the first time, the database changes you make will be persisted in a Docker data volume until/unless you delete it. We plan to provide a pre-populated sample database in the future.
Sage uses gulp as its build system and Bower to manage front-end packages.
gulp— Compile and optimize the files in your assets directorygulp watch— Compile assets when file changes are madegulp --production— Compile assets for production (no source maps).
Detailed documentation for this project will be located in the docs/ folder.
Sage 8.5 documentation is available at https://roots.io/sage/docs/.