jfc3 / 10kapart

First commit for my 10K Apart entry.
0 stars 0 forks source link

John F Croston III Ate Here - Release Notes

Stopped Working this One

Being that this repository is the same as the ATE HERE one only with smaller JSON file sizes to keep the total page load below 10K, I have stopped doing double the work.

If you want to see, the application working live go to John F Croston III Ate Here.

There will be no further code updating at this time unless I try something crazy and don't want to mess with the live version.

Closing out all the open issues too.

Overview

The project you are looking at are restaurants John F Croston III - (@jfc3) had etean at and his 10K Apart entry. The website allows people to select a city, state, or nearby location and see what restauarants I recommend in that location.

When I started this project, I had been thinking about a more involved version of this application that a person could keep track of all the places they wanted to eat when they travel. More of a personal recommendation or list of places to eat. So this was a way to try a few ideas out and make it quick and easy to display restaurant information, along with being only 10 Kb.

This project uses hand-coded JSON files of cities, states, and nearby locations, which currently are the following with their JSON file name after the name:

If you look in the CTY folder, you will find some cities and locations with more than one file. The ones with a dash and the word full (-full) in the name are the full version of the city or location. One of my goals was to create the HTML template and CSS in about 3 - 4Kb, so I had 6 or 7 Kb for content, along with that I wanted the rendered page to be under 10 Kb without minifying or zipping anything. Hopefully, I have done that.

There is a city.josn file that you can use as a tempalte to create other city files.

All the extra CLASSes for each restaurant are there so they have microformats added to them, which is hepful to computers. Look for the 'vcard' CLASS.

I'm working on a more detailed version that is not part of the 10K Apart contest that has my recommendations or ones my friends whose food recommendations I trust, TV shows, blog posts, articles, etc.

So in the near future, I plan on creating an application that people can keep track of the places they want to eat when they travel.

New Features and Enhancements

Features:

Enhancements:

Installation

Please have the following installed before running:

Versioning notation

John F Croston III Ate Here public release notation follows the semantic versioning as outlined on http://semver.org To summarize, Given a version number MAJOR.MINOR.PATCH, increment the:

Additional labels for pre-release, and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Future Notes