Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 3.38 KB

README.md

File metadata and controls

45 lines (31 loc) · 3.38 KB
Raw

Opensource Commons

The Opensource Commons is a project originally built by RE-AMP and Software for Good that aims to help organizations move their communication online so they can collaborate digitally.

Built using Wordpress, Buddypress, Bones Theme and a variety of other plugins, the Commons is relatively simple to setup with some familiarity with those tools.

Installation & Setup

This project assumes some familiarity with Wordpress site setup. It also uses front end tools like SCSS, Compass, and Grunt. While not required, these tools are recommended and the Commons is set up for their use right out of the box.

The only code checked into the repository in the wp-content directory containing plugins and themes and a default database with some basic plugin configuration and pages to get up and running quickly. I also highly recommend using wp-cli to make your Wordpress life a little easier.

###Install

  • create your new project directory and cd into it
  • clone this project
  • Create your database
  • Import the starter database. On a Mac with mysql installed, you should be able to run mysql -u root <databasename> < wordpress-commons-starter-2-16-15.sql after unpacking the database file. By default, the URL is http://opensource-commons.dev

#####With WP-CLI (see docs for more parameters)

  • wp core download
  • wp core config --dbname=<yourdatabasename> --dbuser=<yourdatabaseuser>
  • wp user create <login> <email> --role=administrator

#####Old Fashioned Way

  • Download the Wordpress zip and unpack it
  • Copy everything but the wp-content directory into your project
  • Visit http://opensource-commons.dev and follow the famous 5-minute install. Note that you may need to manually create your wp-config.php from the generated content.

###Login Visit http://opensource-commons.dev and sign in with the user you created on the command line or with the credentials below. You should be all setup! You can access the dashboard at http://opensource-commons.dev/wp-admin. Note that you will want to update the admin URL under "General Settings" and delete the default user as soon as you have a new admin setup.

osc-admin
sIer0waI5His7bO4

###Notes Navigate to the Commons theme to make changes to the theme, update graphics, etc. The project comes setup using SCSS, Compass and Grunt to handle styling. While you could go straight to the stylesheet and begin making changes, this would be a bad idea and make your project harder to maintain. At a minimum, you should install Compass, cd into library/scss and run compass watch. This will compile all your styles.

Better yet, after you have NodeJS and Grunt installed on your system, run npm install from the theme directory to install dependencies. You can then run grunt to automatically watch for changes to the theme and enable live reload.

License

This project is released free for use under GPLv2.0.