restaurant-search-service

1. description

• A restaurant search service to make finding a place for gatherings much more simpler.
• Using RoR as the server-side language to serve the pages.
• A client-side rendered React application.

2. setup

Be sure to first install Bundler and Yarn.

install dependencies

• bundle install
  • Install the dependencies specified in the Gemfile.
• yarn install
  • Install the dependencies specified in the package.json

3. start the server

• rails s
• it's running on http://localhost:3000/ ( http://0.0.0.0:3000 )

4. pages, routes, and features

• check app/javascript/pages/App.jsx for more client-side routing information

4.1. Home Page

• the path of Homepage is /
• it prove restaurant information cards to help users to quickly see what restaurants are open.
• it will show "Closed" on the card if the restaurant is unavailable at the time
  • 
• it have a datetime search input and a submit button to fire the search
  • 
  • 

4.2. Search Result Pag

• the path of Homepage is /search? time=$HHmm & weekday=$weekdayNumber & datetimeMs = $ms
  • if any query parameter not provides in the url, it will redirect to Home Page
• it have a list of restaurants which meets the search criteria, each of the item contains necessary and enough information for users to decide if they want to explore more

4.3. Restaurant Detail Page

• the path of Homepage is /restaurant/:restaurantId
  • if isNaN(parseInt(restaurantId)) or parseInt(restaurantId) out of 0 ~ 49, it will redirect to Home Page
• it contains all the necessary information for the specific restaurant