The housemouse from clai88

housemouse's Introduction

Amazingly simple webapp that allows you to view important home information.

Getting started

To get started, simply visit housemouse and start searching houses right away.

Going through localhost

If you wanted to modify the code and go through localhost, follow the instructions below

Type the following into command prompt:

$ git clone [email protected]:clai88/HouseMouse.git

Run the command:
```
$ bundle install
```
Simply running bundle will also work
Edit any part of the project you desire.

- To modify the routes, open `config/routes.rb`
The format for generating paths and URL's is: ```rb get '/house/:id' => 'house#show', as: 'house' ``` Alternatively, simply entering the line below will generate all CRUD routes for the matching controller ```rb resources :house ```

- In order to generate a new migration, type:
`
$ bin/rails g migration NAME [field[:type][:index] field[:type][:index]]
`

- To edit the models, views, and controllers, visit the `app/` directory <br />

>After editing the databases (generating new model or migrations), run the command `$ rake db:migrate`, which will run single migrations that have not been run yet.  
<br>
A list of your current tables and their columns can be found at `db/schema.rb`.
<br>
<br>
If you edit the Gemfile, be sure to `bundle` afterwards

To start your rails app, run:
```
bin/rails server
```
By default, the rails app will start on port 3000, but you can change this with the modifier
```
bin/rails s -p #anyport
```
To be safe, please make sure the port is between 1024 and 65535
To see your edits come to life, open your browser and enter
```
localhost:3000 (or whichever port you chose)
```
Celebrate! You're on Rails!

TDO

Search houses
View previously searched houses
Star, edit,and delete previously searched houses
View mortgage information for ~~most~~ all houses

Screenshots

##Feature request HouseMouse currently only utilizes zillow and walkscore's api, but if you like to see more API's implemented, please contact me at [email protected]

Recommend Projects