Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.53 KB

README.md

File metadata and controls

63 lines (41 loc) · 3.53 KB
Raw

Real Reality (winner of Prague Hacks 2016 Hackathon)

Build Status codecov

When you want to buy or rent an apartment (house) you do (or should do) research about things that matter to you. Air pollution, parking, public transport availability (commutation time!), noisiness, places for kids...you name it. But it is unfortunately very time consuming. Until now! Now you've got our beautiful Chrome extension which do all the research for you. Well right now just part of it, but more will come!

Original idea was that Real Reality will be webpage where you can see mashup of real estate offers and interesting data (see above). But it's more work and we want to just show proof of concept before next steps, so we choose to create Chrome extension first (extension deployed to Chrome Web Store).

What to do next?

  1. web page which aggregates or have real estate offers and enrich them with data we've got (thanks to http://www.iprpraha.cz/)
  2. thirdparty widget (like google analytics) which can any webmaster add to it's page with real estate offers.
  3. add more enrichments
  4. better UI/UX
  5. .... your idea ....

Hacking

  1. get code git clone git@github.com:realreality/reality-plugin.git
  2. inside run yarn / npm install to install dependencies
  3. yarn start / npm start starts a dev servers and creates a ./build directory in <project-root> which can be loaded as unpacked extension in Chrome (type to url bar chrome://extensions)
  4. <your-code-here>
  5. to get the production version run yarn build / npm run build
  6. check the code style with yarn lint / npm run lint
  7. git commit -m "my new great addition!"
  8. git push

Final extension structure

build
├── _locales
├── background.bundle.js
├── contentscript.bundle.js
├── css
├── fonts
├── images
└── manifest.json

Environment variables

This project supports dotenv variables, by creating a .env file, you can put your secrets there. All env variables are then available in ./config/env.js where you can export them and use in webpack DefinePlugin in webpack.conf.js

  • GMAPS_API_KEY - user your own please
  • IPR_REST_API - endpoint for real-reality

Quick and dirty source code of IPR Data Rest API Server.

Main script is in ./src/js/contentscript.js

IPR API is backed by IPR Data Rest API Server.

Thanks to

Institut plánování a rozvoje hlavního města Prahy for releasing used data sets (like air pollution) for free.

Open Society Fund Praha / Fond Otakara Motejla for their open data activities (like organizing Prague Hacks hackathon and other similar events, propagation the open data idea in goverment institutions..etc.).

Samuel Simões - this extension is built on top of the scaffold chrome-extension-webpack-boilerplate