Map Based Search

Simple responsive website that allows the user to search for a city and displays tweets that mention the city on a map. (support english only)

Getting Started

1. Setup web server
2. Install Composer
3. Browse to project directory
4. Install dependencies: composer install
5. Setup config below and seed database by: php artisan migrate

5.1 Server environment variable
SetEnv MBS_SITE_ENV "prod"
SetEnv MBS_SERVER_NAME "mbs.jojoee.com"

5.2 Database
app/config/database.php
app/config/local/database.php

5.3 Constant
app/config/constants.php

Screenshot

Feature

• Responsive
• User searches for a city and display user (that tweet the city) profile picture as the Marker, show between 10-20 tweets
• Search tweets (tweet's radius: 50km) that contain city name, within 50km of location and contain coordinate data
• When click the Marker then display info window which contain tweet's text and tweet's time
• Search history (history of searches made) order by most recent first
• Cache tweet (Backend): MySQL (1 hour for each location)
• Cache tweet (Frontend): localStorage
• History search: Use cookies to identify the user (20 maximum search history item)
• Map by Google Maps with Snazzy Maps
• Task runner: gulp.js, also create build Frontend script
• Implement ORM (e.g. Doctrine)
• Upgrade to Laravel 5.3
• Add deployment script (e.g. Deployer)
• City auto completion (or city validation)
• Popup error message when not found any tweet from search
• Database migration & seed
• Add redundant resources
• Test (Backend): User acceptance
• Test (Backend): Unit
• Test (Backend): Functional
• Test (Frontend): Unit
• Test (Frontend): E2E
• Refactor (Backend): Route
• Refactor (Backend): Model
• Refactor (Backend): Separate business logic out off controller (create Service for business logic)
• Refactor (Javascript): Convert to module pattern
• Using faker for dummy stuff

Compatibility

• Google Chrome 51+
• Internet Explorer 10+
• Mozilla Firefox 43+
• Opera 41+
• Safari (desktop) 5+

Note

• Laravel 4.2
• Javascript DocBlockr: JSDoc
• PHP Code styling: PhpStorm Laravel Code Style instead of Laravel 4.2
• PHP DocBlockr: phpDocumentor
• Javascript Code styling: Airbnb
• WinLess: Online LESS Compiler