From b34988e7b1a6df6ccd7c588d872f343c65c51f0e Mon Sep 17 00:00:00 2001 From: Aaron Wiggins Date: Tue, 21 Jul 2015 17:11:48 -0400 Subject: [PATCH] create README --- Gemfile | 1 - Gemfile.lock | 4 ---- README.rdoc | 68 ++++++++++++++++++++++++++++++---------------------- 3 files changed, 40 insertions(+), 33 deletions(-) diff --git a/Gemfile b/Gemfile index 2d6ef28..2c51775 100644 --- a/Gemfile +++ b/Gemfile @@ -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' diff --git a/Gemfile.lock b/Gemfile.lock index 2d3fe02..9197f94 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -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) @@ -195,7 +192,6 @@ DEPENDENCIES jbuilder (~> 2.0) jquery-rails jquery-ui-rails - kaminari paperclip pg puma diff --git a/README.rdoc b/README.rdoc index dd4e97e..edcdd48 100644 --- a/README.rdoc +++ b/README.rdoc @@ -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 -rake doc:app. +#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)