{"id":18780668,"url":"https://github.com/simplicitesoftware/module-restaurants","last_synced_at":"2025-08-13T18:19:00.349Z","repository":{"id":80897270,"uuid":"243773858","full_name":"simplicitesoftware/module-restaurants","owner":"simplicitesoftware","description":"Restaurants rating demo for Simplicité","archived":false,"fork":false,"pushed_at":"2022-06-09T13:43:13.000Z","size":628,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-29T10:44:58.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplicitesoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-02-28T13:53:59.000Z","updated_at":"2021-10-01T16:19:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"f0457663-f9ac-4d70-8f48-72ae1f8c20e9","html_url":"https://github.com/simplicitesoftware/module-restaurants","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/simplicitesoftware%2Fmodule-restaurants","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplicitesoftware%2Fmodule-restaurants/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplicitesoftware%2Fmodule-restaurants/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplicitesoftware%2Fmodule-restaurants/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplicitesoftware","download_url":"https://codeload.github.com/simplicitesoftware/module-restaurants/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239697375,"owners_count":19682409,"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":[],"created_at":"2024-11-07T20:27:34.382Z","updated_at":"2025-02-19T16:41:58.503Z","avatar_url":"https://github.com/simplicitesoftware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n ___ _            _ _    _ _    __\n/ __(_)_ __  _ __| (_)__(_) |_ /_/\n\\__ \\ | '  \\| '_ \\ | / _| |  _/ -_)\n|___/_|_|_|_| .__/_|_\\__|_|\\__\\___|\n            |_| \n--\u003e\n![](https://docs.simplicite.io//logos/logo250.png)\n* * *\n\n`RestaurantsDemo` module definition\n===================================\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=simplicite-modules-RestaurantsDemo\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=simplicite-modules-RestaurantsDemo)\n\n### Introduction\n\nThis module is a very simple restaurant rating application demo\ninspired by a famous travelers' advisor service.\n\nThe frontend is a [NodeRED\u0026reg;](https://nodered.org) web application.\n\n### Import\n\nTo import this module:\n\n- Create a module named `RestaurantsDemo`\n- Set the settings as:\n\n```json\n{\n\t\"type\": \"git\",\n\t\"origin\": {\n\t\t\"uri\": \"https://github.com/simplicitesoftware/module-restaurants.git\"\n\t}\n}\n```\n\n- Click on the _Import module_ button\n\n### Configure backend\n\nIn order to have the frontend working the password for the\nwebservices-only user `rstfrontend` must be `simplicite`.\n\nThis can be achieved by importing the following XML:\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003csimplicite xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://www.simplicite.fr/base\" xsi:schemaLocation=\"http://www.simplicite.fr/base https://www.simplicite.io/resources/schemas/base.xsd\"\u003e\n\u003cobject\u003e\n\t\u003cname\u003eUserPwd\u003c/name\u003e\n\t\u003caction\u003eupdate\u003c/action\u003e\n\t\u003cdata\u003e\n\t\t\u003cusr_login_read\u003erstfrontend\u003c/usr_login_read\u003e\n\t\t\u003cusr_password\u003esimplicite\u003c/usr_password\u003e\n\t\u003c/data\u003e\n\u003c/object\u003e\n\u003c/simplicite\u003e\n```\n\n### Load dataConfigure frontend\n\nInstall [NodeRED\u0026reg;](https://nodered.org).\n\nStart it with your Google API key set as a environment variable: `GOOGLE_API_KEY=_myapikey_ node-red`\n\nIn the NodeRED flow editor add the following nodes to the nodes palette (in the main menu choose the _Manage palette_ option):\n\n- Simplicité nodes: `node-red-contrib-simplicite`\n- Sentiment analysis nodes: `node-red-node-sentiment`\n- Watson nodes: `node-red-node-watson`\n\nImport the flows available in the `RST_NODERED_NODES` resource of the module.\n\nConfigure the config node with your instance settings.\n\n`RstLocation` business object definition\n----------------------------------------\n\nLocation\n\n### Fields\n\n| Name                                                         | Type                                     | Required | Updatable | Personal | Description                                                                      |\n|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|\n| `rstLocName`                                                 | char(100)                                | yes*     | yes       |          | Location name                                                                    |\n| `rstLocState`                                                | enum(2) using `RST_STATES` list          | yes*     | yes       |          | Location state                                                                   |\n| `rstLocDescription`                                          | html(4000)                               |          | yes       |          | Location description                                                             |\n| `rstLocCoordinates`                                          | geocoords                                | yes      | yes       |          | Location coordinates                                                             |\n| `rstLocExtent`                                               | int(10)                                  | yes      | yes       |          | Location extent (miles)                                                          |\n\n### Lists\n\n* `RST_STATES`\n    - `AL` Alabama\n    - `AK` Alaska\n    - `AZ` Arizona\n    - `AR` Arkansas\n    - `CA` California\n    - `CO` Colorado\n    - `CT` Connecticut\n    - `DE` Delaware\n    - `DC` District of Columbia\n    - `FL` Florida\n    - `GA` Georgia\n    - `HI` Hawaii\n    - `ID` Idaho\n    - `IL` Illinois\n    - `IN` Indiana\n    - `IA` Iowa\n    - `KS` Kansas\n    - `KY` Kentucky\n    - `LA` Louisiana\n    - `ME` Maine\n    - `MD` Maryland\n    - `MA` Massachusetts\n    - `MI` Michigan\n    - `MN` Minnesota\n    - `MS` Mississippi\n    - `MO` Missouri\n    - `MT` Montana\n    - `NE` Nebraska\n    - `NV` Nevada\n    - `NH` New Hampshire\n    - `NJ` New Jersey\n    - `NM` New Mexico\n    - `NY` New York\n    - `NC` North Carolina\n    - `ND` North Dakota\n    - `OH` Ohio\n    - `OK` Oklahoma\n    - `OR` Oregon\n    - `PA` Pennsylvania\n    - `RI` Rhode Island\n    - `SC` South Carolina\n    - `SD` South Dakota\n    - `TN` Tennessee\n    - `TX` Texas\n    - `UT` Utah\n    - `VT` Vermont\n    - `VA` Virginia\n    - `WA` Washington\n    - `WV` West Virginia\n    - `WI` Wisconsin\n    - `WY` Wyoming\n\n### Custom actions\n\n* `RstLoadRestaurants`: Refresh all restaurants' data\n\n`RstRestaurant` business object definition\n------------------------------------------\n\nRestaurant (as referenced as POI in OpenStreetMap) + extra data\nThe restaurants without a name or a state are ignored\n\n### Fields\n\n| Name                                                         | Type                                     | Required | Updatable | Personal | Description                                                                      |\n|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|\n| `rstRstName`                                                 | char(100)                                | yes*     |           |          | Name                                                                             |\n| `rstRstState`                                                | enum(2) using `RST_STATES` list          |          |           |          | State (e.g. `NY`)                                                                |\n| `rstRstCuisine`                                              | char(50)                                 |          |           |          | Cuisine type                                                                     |\n| `rstRstWebSite`                                              | url(100)                                 |          |           |          | Web site                                                                         |\n| `rstRstAddress`                                              | char(255)                                |          |           |          | Address                                                                          |\n| `rstRstCoordinates`                                          | geocoords                                |          |           |          | Geographical coordinates                                                         |\n| `rstRstTimestamp`                                            | datetime                                 |          |           |          | Data timestamp                                                                   |\n| `rstRstStatus`                                               | enum(10) using `RST_STATUS` list         |          | yes       |          | Status                                                                           |\n| `rstRstNbComments`                                           | int(10)                                  |          |           |          | Number of comments                                                               |\n| `rstRstRating`                                               | float(11, 0)                             |          |           |          | Rating                                                                           |\n| `rstRstDescription`                                          | html(4000)                               |          | yes       |          | Description                                                                      |\n| `rstRstPicture`                                              | image                                    |          | yes       |          | Picture                                                                          |\n| `rstRstLocId` link to **`RstLocation`**                      | id                                       | yes      | yes       |          | -                                                                                |\n| _Ref. `rstRstLocId.rstLocName`_                              | _char(100)_                              |          |           |          | _Location name_                                                                  |\n| _Ref. `rstRstLocId.rstLocState`_                             | _enum(2) using `RST_STATES` list_        |          |           |          | _Location state_                                                                 |\n| _Ref. `rstRstLocId.rstLocCoordinates`_                       | _geocoords_                              |          |           |          | _Location coordinates_                                                           |\n| _Ref. `rstRstLocId.rstLocExtent`_                            | _int(10)_                                |          |           |          | _Location extent (miles)_                                                        |\n\n### Lists\n\n* `RST_STATES`\n    - `AL` Alabama\n    - `AK` Alaska\n    - `AZ` Arizona\n    - `AR` Arkansas\n    - `CA` California\n    - `CO` Colorado\n    - `CT` Connecticut\n    - `DE` Delaware\n    - `DC` District of Columbia\n    - `FL` Florida\n    - `GA` Georgia\n    - `HI` Hawaii\n    - `ID` Idaho\n    - `IL` Illinois\n    - `IN` Indiana\n    - `IA` Iowa\n    - `KS` Kansas\n    - `KY` Kentucky\n    - `LA` Louisiana\n    - `ME` Maine\n    - `MD` Maryland\n    - `MA` Massachusetts\n    - `MI` Michigan\n    - `MN` Minnesota\n    - `MS` Mississippi\n    - `MO` Missouri\n    - `MT` Montana\n    - `NE` Nebraska\n    - `NV` Nevada\n    - `NH` New Hampshire\n    - `NJ` New Jersey\n    - `NM` New Mexico\n    - `NY` New York\n    - `NC` North Carolina\n    - `ND` North Dakota\n    - `OH` Ohio\n    - `OK` Oklahoma\n    - `OR` Oregon\n    - `PA` Pennsylvania\n    - `RI` Rhode Island\n    - `SC` South Carolina\n    - `SD` South Dakota\n    - `TN` Tennessee\n    - `TX` Texas\n    - `UT` Utah\n    - `VT` Vermont\n    - `VA` Virginia\n    - `WA` Washington\n    - `WV` West Virginia\n    - `WI` Wisconsin\n    - `WY` Wyoming\n* `RST_STATUS`\n    - `CLOSED` Code CLOSED\n    - `OPEN` Code OPEN\n\n`RstComments` business object definition\n----------------------------------------\n\nCustomer comments on a restaurant. Includes:\n\n* an quantified evaluation\n* free text comments\n\n### Fields\n\n| Name                                                         | Type                                     | Required | Updatable | Personal | Description                                                                      |\n|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|\n| `rstCmtDateTime`                                             | datetime                                 | yes*     |           |          | Date and time                                                                    |\n| `rstCmtEmail`                                                | char(100)                                | yes      | yes       |          | Customer's name                                                                  |\n| `rstCmtRstId` link to **`RstRestaurant`**                    | id                                       | yes*     | yes       |          | Restaurant                                                                       |\n| _Ref. `rstCmtRstId.rstRstName`_                              | _char(100)_                              |          |           |          | _Name_                                                                           |\n| _Ref. `rstCmtRstId.rstRstAddress`_                           | _char(255)_                              |          |           |          | _Address_                                                                        |\n| _Ref. `rstCmtRstId.rstRstState`_                             | _enum(2) using `RST_STATES` list_        |          |           |          | _State (e.g. `NY`)_                                                              |\n| `rstCmtEval`                                                 | int(1) using `RST_EVAL` list             | yes      | yes       |          | Evaluation                                                                       |\n| `rstCmtSentiment`                                            | int(2)                                   |          | yes       |          | Sentiment score                                                                  |\n| `rstCmtComments`                                             | text(4000)                               |          | yes       |          | Free text comments in **native** language                                        |\n| `rstCmtCommentsInEnglish`                                    | text(4000)                               |          |           |          | Free text comments translated in **english**                                     |\n| `rstCmtTones`                                                | text(4000)                               |          | yes       |          | Watson tones                                                                     |\n| `rstCmtVisible`                                              | boolean                                  |          | yes       |          | Visible?                                                                         |\n\n### Lists\n\n* `RST_STATES`\n    - `AL` Alabama\n    - `AK` Alaska\n    - `AZ` Arizona\n    - `AR` Arkansas\n    - `CA` California\n    - `CO` Colorado\n    - `CT` Connecticut\n    - `DE` Delaware\n    - `DC` District of Columbia\n    - `FL` Florida\n    - `GA` Georgia\n    - `HI` Hawaii\n    - `ID` Idaho\n    - `IL` Illinois\n    - `IN` Indiana\n    - `IA` Iowa\n    - `KS` Kansas\n    - `KY` Kentucky\n    - `LA` Louisiana\n    - `ME` Maine\n    - `MD` Maryland\n    - `MA` Massachusetts\n    - `MI` Michigan\n    - `MN` Minnesota\n    - `MS` Mississippi\n    - `MO` Missouri\n    - `MT` Montana\n    - `NE` Nebraska\n    - `NV` Nevada\n    - `NH` New Hampshire\n    - `NJ` New Jersey\n    - `NM` New Mexico\n    - `NY` New York\n    - `NC` North Carolina\n    - `ND` North Dakota\n    - `OH` Ohio\n    - `OK` Oklahoma\n    - `OR` Oregon\n    - `PA` Pennsylvania\n    - `RI` Rhode Island\n    - `SC` South Carolina\n    - `SD` South Dakota\n    - `TN` Tennessee\n    - `TX` Texas\n    - `UT` Utah\n    - `VT` Vermont\n    - `VA` Virginia\n    - `WA` Washington\n    - `WV` West Virginia\n    - `WI` Wisconsin\n    - `WY` Wyoming\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplicitesoftware%2Fmodule-restaurants","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplicitesoftware%2Fmodule-restaurants","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplicitesoftware%2Fmodule-restaurants/lists"}