{"id":20826720,"url":"https://github.com/cedrickchee/soshiok","last_synced_at":"2025-12-24T21:52:16.313Z","repository":{"id":138118893,"uuid":"92389815","full_name":"cedrickchee/soshiok","owner":"cedrickchee","description":"A full stack restaurant app","archived":false,"fork":false,"pushed_at":"2017-06-17T13:31:38.000Z","size":13909,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-18T17:49:36.186Z","etag":null,"topics":["ecmascript2015","es6","expressjs","food","fullstack-javascript","javascript","nodejs","restaurant-management","store-locator","webapp"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cedrickchee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-25T09:55:44.000Z","updated_at":"2024-11-01T11:38:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"3ce6d689-d5eb-48d7-a3a3-4654aea2299a","html_url":"https://github.com/cedrickchee/soshiok","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickchee%2Fsoshiok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickchee%2Fsoshiok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickchee%2Fsoshiok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedrickchee%2Fsoshiok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cedrickchee","download_url":"https://codeload.github.com/cedrickchee/soshiok/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243174005,"owners_count":20248214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecmascript2015","es6","expressjs","food","fullstack-javascript","javascript","nodejs","restaurant-management","store-locator","webapp"],"created_at":"2024-11-17T23:09:50.883Z","updated_at":"2025-12-24T21:52:16.282Z","avatar_url":"https://github.com/cedrickchee.png","language":"JavaScript","readme":"# SoShiok \u0026middot; [![Build Status](https://img.shields.io/travis/cedrickchee/soshiok/master.svg?style=flat)](https://travis-ci.org/cedrickchee/soshiok)\n\nA full stack restaurant app built using Node.js 7.6+ and modern JavaScript.\n\n***Note: Please do not use this for production. The application is still under heavy development and the API is not stable.***\n\n## Overview\n\n* [Features](#features)\n* [Application Architecture](#architecture)\n  * [Functionalties](#functionalties)\n  * [Development Stack](#development)\n* [Quickstart](#quickstart)\n* [Documentation](#documentation)\n  * [Standard](#standard)\n  * [Sample Data](#data)\n  * [Deployment](#deployment)\n\n## Features\n\nUsers can:\n- Search\n- Geolocate\n- Review\n- Curate their favourite restaurants\n\n## Architecture\n\nThe application has three main models\n- Users\n- Stores\n- Reviews\n\nAll models are relational.\n\n### Functionalties\n\nThe application is designed for today's technology needs such as:\n- User authentication\n- Database storage\n- AJAX REST API\n- File upload and image resizing\n\n### Development\n\nModern JavaScript:\n- ECMAScript 6 (ES6) also known as ECMAScript 2015 (ES2015)\n  - ES6 features are heavily used throughout the app, from destructuring to arrow functions\n- ES6 Async + Await\n  - It allows us to craft easy to read, logical flows without relying on external flow control libraries, chaining multiple promises, or writing spaghetti code by nesting callbacks\n- [Express](https://expressjs.com/)\n  - Fast, unopinionated, minimalist web framework for Node.js\n- [Pug](https://pugjs.org/)\n  - Formerly known as \"Jade\"\n  - A robust, elegant, feature rich template engine for Node.js\n- [Passport](http://passportjs.org/)\n  - A simple, unobtrusive authentication for Node.js\n  - Passport is a middleware for Node.js\n- [Sass](http://sass-lang.com/) (Syntactically awesome style sheets)\n  - A CSS preprocessor\n- [Webpack](https://webpack.js.org/)\n  - A module bundler for modern JavaScript applications\n- [MongoDB](https://www.mongodb.com/)\n  - A document-oriented database and NoSQL database\n  - Uses JSON-like documents with schemas\n\n## Quickstart\n\nBasically, the app was developed in ES6. You should have knowledge of how functions, variables, Objects, Arrays and other JavaScript fundamentals work.\n\nPrerequisite:\n- Runtime: make sure we have Node.js 7.6 and above installed in our development environment.\n- Database: we are using MongoDB 3.2.x\n\nThen, clone the git repo. Rename `variables.env.sample` to `variables.env`. Update the environment settings in this configuration file.\n\nRun the following command in your terminal:\n\nInstall all node packages (dependencies) listed in `package.json` file:\n\n```bash\nnpm install\n```\n\nStart our server and run the app:\n\n```bash\nnpm start\n```\n\n## Documentation\n\n### Standard\n\nThe app was designed and developed based on widely adopted general JavaScript best practices from the industry's best Node.js developers.\n\n### Data\n\nTo load sample data, run the following command in your terminal:\n\n```bash\nnpm run sample\n```\n\nIf you have previously loaded in this data, you can wipe your database 100% clean with:\n\n```bash\nnpm run blowitallaway\n```\n\nThat will populate 16 stores with 3 authors and 41 reviews. The logins for the authors are as follows:\n\n|Name|Email (login)|Password|\n|---|---|---|\n|Cedric Chee|cedric@example.com|cedric|\n|John Doe|john@example.com|john|\n|Foo Bar|foo@example.com|foo|\n\n### Deployment\n\nSupports:\n- [x] Deploying to Now\n- [ ] Deploying to Heroku\n- [ ] Digital Ocean Linux\n\n## License\n\n**SoShiok** is an open-source software and is licensed under the [MIT License](./LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedrickchee%2Fsoshiok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcedrickchee%2Fsoshiok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedrickchee%2Fsoshiok/lists"}