National Park Volunteer Application
Ruby JavaScript CoffeeScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
features
lib
log
public
script
spec
vendor
.gitignore
.rvmrc
Gemfile
Gemfile.lock
LICENSE
README.rst
Rakefile
config.ru

README.rst

icandothat-signmeup

repo :: https://github.com/icandothat-signmeup/icandothat-signmeup heroku :: http://smu.herokuapp.com/ heroku :: http://rhok-atl-park.herokuapp.com/

DESCRIPTION

Icandothat-signmeup is a way to offer to sign up for volunteer actvities.

Icandothat-signmeup is still in early development, so now is the time to make your mark on the project.

FEATURES/PROBLEMS

SYNOPSYS

  • % TBD/USAGE

Getting Started

TBD

INSTALL

# Checkout the project $ git clone https://github.com/icandothat-signmeup/icandothat-signmeup $ cd icandothat-signmeup

# Install the project dependencies $ gem install bundler $ bundle install

# Set up the development database. $ rake db:migrate

# Start the local web server $ rails server

You should then be able to navigate to http://localhost:3000/ in a web browser.

HOW TO USE POSTGRES INSTEAD OF SQLITE3 (ASSUMING NO DATA IN DATABASE)

Assuming you have postgres installed in your environment, here are the extra steps needed prior to running "rails server".

  • Run "pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start" to start up the database server.
  • FYI: To stop, do this: "pg_ctl -D /usr/local/var/postgres stop -s -m fast"
  • Run "rake db:drop:all db:create:all db:migrate db:seed" to create the database tables and seed the initial seed data.

HERKOKU SETUP

If you wish to host a publicly available copy of icandothat-signmeup, the easiest option is to host it on [Heroku](http://heroku.com/).

# Make sure you have the Heroku gem $ gem install heroku

# Create your app. Replace APPNAME with whatever you want to name it. $ heroku create APPNAME

# Define where the user emails will be coming from # (This email address does not need to exist) $ heroku config:add MAILER_SENDER=noreply@example.org

# Allow emails to be sent $ heroku addons:add sendgrid:starter

# Deploy the first version $ git push heroku master

To deploy it to Heroku, make sure you have a local copy of the project; refer to the previous section for instuctions. Then:

# Set up the database $ heroku rake db:setup

Once that's done, you will be able to view your site at http://APPNAME.heroku.com.

TO CONTRIBUTE

icandothat-signmeup is currently welcoming contributions. If you'd like to help:

Here are some general guidelines for contributing:

  • Check the [issue queue] in Pivotal Tracker

    https://www.pivotaltracker.com/projects/565693

    for a list of the major features which are yet to be implemented. These have the feature and unstarted labels. If a feature you'd like isn't there, add an issue to the Icebox.

  • If you'd like to take ownership of one of the features, leave a

    comment on the issue queue indicating that you're working on it.

  • If you'd like to discuss anything about the issue with other

    developers, do so on the [Emerald Programming Group] (https://groups.google.com/group/atlrug-emeraldcity) mailing list.

  • Fork github project:

    https://github.com/icandothat-signmeup/icandothat-signmeup

  • Make your changes on a branch, and use that branch as the base

    for pull requests.

  • We encourage you try to break changes up into the smallest logical

    blocks possible. We would prefer to receive many small commits to one large one in a pull request.

  • Feel free to open unfinished pull requests if you'd like to discuss

    work in progress, or would like other developers to test it.

  • All patches changes need to be covered by tests and should not

    break the existing tests, unless a current test is invalidated by a code change.

  • Read over documentation.

  • Run rake to check the Rails test/spec suite is green.

  • If you have any questions please post them to the <Emerald City> group.

  • Also attend the <Emerald City> Saturday classes.

Credits

CB Genrich Al Snow Dan Schlossberg Ed La Hoz deltatangomike

README FORMAT

See http://docutils.sourceforge.net/docs/user/rst/quickref.html for more information about the format used in the file. It is called Restructured Text.