Kuizine is a cross-platform mobile application designed to aggregate all of the restaurant options within the town of Kutztown, PA. It provides relevant restaurant information including menu, website, contact information, address, and a map of the restaurant location. Further, it provides users with an account the ability to save their favorite restaurants, and provides all users the ability to search and browse for restaurants.
This section will outline the naming conventions coding guidelines for each language used in the development of this app.
- Use 4 spaces for tabs (replace \t character with spaces)
- Filenames shall be short, descriptive, and one-word where possible; if necessary use "this_format"
- Strive for consistency to the greatest degree possible
- Document code sufficiently, regardless of language
- Tag attributes will be listed in alphabetical order, unless there is an appropriate reason to do otherwise
- HTML should not contain unnecessary attributes and be consistent across files
- Class names will follow "this-format"
- CSS stylesheets will follow "this-format"
- CSS styles shall be specified within an appropriate external file, not inline where possible.
- CSS will be aligned using a package called atom-alignment
- CSS should contain logical section headers using comment blocks
- Variable and function names shall follow "this_format"
- Variable and function names shall follow "thisFormat"
- AngularJS factory, service, etc. names shall follow "ThisFormat"
- Table names shall follow "This_Format"
- Table attribute names shall follow "this_format"
Changes can now be found in CHANGELOG.md.