Skip to content

Commit

Permalink
create README
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronwiggins committed Jul 21, 2015
1 parent 5f3e373 commit b34988e
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 33 deletions.
1 change: 0 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ gem 'aws-sdk', '~> 1.6'
gem 'ratyrate'
gem 'devise'
gem "font-awesome-rails"
gem 'kaminari'
gem 'rails-footnotes', '~> 4.0'
# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
gem 'rails', '4.2.1'
Expand Down
4 changes: 0 additions & 4 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,6 @@ GEM
jquery-ui-rails (5.0.5)
railties (>= 3.2.16)
json (1.8.3)
kaminari (0.16.3)
actionpack (>= 3.0.0)
activesupport (>= 3.0.0)
loofah (2.0.2)
nokogiri (>= 1.5.9)
mail (2.6.3)
Expand Down Expand Up @@ -195,7 +192,6 @@ DEPENDENCIES
jbuilder (~> 2.0)
jquery-rails
jquery-ui-rails
kaminari
paperclip
pg
puma
Expand Down
68 changes: 40 additions & 28 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,40 @@
== README

This README would normally document whatever steps are necessary to get the
application up and running.

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...


Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.
#Stempirical

Stempirical is a crowdsourced collection of age appropriate and engaging science experiments.
What sets this site apart from similar sites is that in addition to showing the materials and instructions (the how),
we also explore the scientific explanations behind the experiment (the why).
Stempirical is a space where rainy-day science experiments are both entertaining and educational.

This project was create by two Ruby on Rails developers, [Aaron Wiggins](https://github.com/aaronwiggins)
and [Daisy Magnus](https://github.com/DaisyMagnus) and one Front End Developer, [Lindsey Miller](https://github.com/lindcmiller) from
The Iron Yard Durham.

Check out our individual github profiles by clicking on our names to see more of our work.

* A link to our [ERD](https://www.lucidchart.com/invitations/accept/e9f80ee0-ad89-4b80-8cc5-246180c68e76) to get a better understand of our database structure
* [Stempirical](https://stempirical.herokuapp.com/experiments) to see our site live!

###To Run the App Locally
* Clone our repo with this link [here](https://github.com/AaronLindsayDaisy/final_project.git)
* `bin/rake db:migrate`
* `bin/rake db:seed`
* `bin/rails server`
* Navigate to your localhost in your browser

###To Upload Your Own Photos on Localhost
* We've used the gem `paperclip` for uploaded files.
* You'll need to create an amazon web services account [here](http://aws.amazon.com/s3/).
* Create a bucket, name it whatever you want. This will be where your photos are stored.
* You'll need to genereate your on AWS ID and KEY. Once you do, save those as
local environment variables.
* Our env variables are saved in the `application.rb` file in the config folder.
* Change `stempirical` to whatever you named your bucket on your AWS account.
* If your local env variables are saved with the same name as ours, that's all you have to do.
If you created your own, you'll replace ours with whatever yours are named.
* Restart your terminal and you will be able to upload your own photos to localhost.

###Gems We've Used
* [`gem 'paperclip'`](https://github.com/thoughtbot/paperclip)
* [`gem 'ratyrate'`](https://github.com/wazery/ratyrate)
* [`gem 'devise'`](https://github.com/plataformatec/devise)
* [`gem 'font-awesome-rails'`](https://github.com/bokmann/font-awesome-rails)

0 comments on commit b34988e

Please sign in to comment.