18F / dashboard

DEPRECATED: A site to track our projects' status and much, much more...
Other
44 stars 25 forks source link

Setup script for oss adopters #297

Open gboone opened 8 years ago

gboone commented 8 years ago

We should include a script that will setup this repo for someone outside of 18F looking to reuse this code. Right now a user would have to do the following:

  1. Set up the project
  2. Remove the _config.yml that's in the repo and rename the _config.yml.sample to _config.yml
  3. Rename the projects.json.example file to "projects.json".

Now, if you run ./go serve now you should see something similar to what you see at 18f.gsa.gov/dashboard

  1. Change the values in the _config.yml file to better reflect your organization.
  2. Rename the projects in the projects.json file you created before and replace their values with ones that fit your organizations projects.

As a person who wants a Dashboard I want to set it up without too much of 18F's configuration so that I can use it for my own organization.