Giter VIP home page Giter VIP logo

munichflatfinder's Introduction

The Munich Flat Finder

Overview

See the Project Pitch on this presentation

What is this app for?

This is an app to help newcomers in Munich find a flat.

What does it do?

This app will allow users to search for appartment listings for various areas in Munich. They will also see information about each area. In the FAQ section, they will be able to see tips to find a flat and what to do next.

How does it work

This app uses a 'fake' API from ImmobilienScout24 and Google Maps to show listings in Munich. The site is styled with Bootstrap, the pictures come from Pixabay, with a creative common 0 license.

Features

Existing Features

-General Features

  • A responsive website for mobile, tablet and desktop.

  • Flat Search

    • Show a list of search results for flats Note
    • Show results according to each area
    • Show other relevant data for each area.
  • FAQ

    • A bootstrap accordeon to present Q&A
  • Contact Form

    • Validate the form

Features to Implement

  • Flat Search:
    • Use the real API from Immoscout

Tech Used

Some the tech used includes:

  • AngularJS
    • We use AngularJS to handle page routing, we also use it to make calls to the REST API and build custom directives
  • Bootstrap
    • We use Bootstrap to give our project a simple, responsive layout
  • npm
    • We use npm to help manage some of the dependencies in our application
  • bower
    • Bower is used to manage the installation of our libraries and frameworks

Testing

All the tests can be found on this document.

Contributing

Getting the code up and running

  1. Firstly you will need to clone this repository by running the git clone https://github.com/mathilde206/MunichFlatFinder.git command
  2. After you've that you'll need to make sure that you have npm and bower installed
  3. You can get npm by installing Node from here
  4. Once you've done this you'll need to run the following command: npm install -g bower # this may require sudo on Mac/Linux
  5. Once npm and bower are installed, you'll need to install all of the dependencies in package.json and bower.json
npm install

bower install
  1. After those dependencies have been installed you'll need to make sure that you have http-server installed. You can install this by running the following: npm install -g http-server # this also may require sudo on Mac/Linux
  2. Once http-server is installed run http-server -c-1
  3. The project will now run on localhost
  4. Make changes to the code and if you think it belongs in here then just submit a pull request

Contribute ideas

If you would like to contribute to the content (extra tips about Munich, correct a wront information), feel free to get in touch with me.

munichflatfinder's People

Contributors

mathilde206 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.