{"id":23291044,"url":"https://github.com/jplusplus/idf-interactive","last_synced_at":"2025-04-06T17:44:38.587Z","repository":{"id":68569378,"uuid":"8774110","full_name":"jplusplus/idf-interactive","owner":"jplusplus","description":"Ile-de-France Interactive","archived":false,"fork":false,"pushed_at":"2014-11-17T11:39:21.000Z","size":18145,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-14T04:55:28.491Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/jplusplus.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}},"created_at":"2013-03-14T11:41:12.000Z","updated_at":"2016-01-22T16:23:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"eee2d5c3-e218-4877-b054-d90440b423b0","html_url":"https://github.com/jplusplus/idf-interactive","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/jplusplus%2Fidf-interactive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jplusplus%2Fidf-interactive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jplusplus%2Fidf-interactive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jplusplus%2Fidf-interactive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jplusplus","download_url":"https://codeload.github.com/jplusplus/idf-interactive/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526675,"owners_count":20953141,"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-12-20T05:13:56.387Z","updated_at":"2025-04-06T17:44:38.546Z","avatar_url":"https://github.com/jplusplus.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ile-de-France Interactive \n## Installation\n### Software dependencies\nTo make this project up and running, you need:\n\n* **Node** 0.8.7\n* **CoffeeScript** 1.6.2\n* **NPM** 1.1.32\n\n\n### Dependencies\nThis project is build at the top of the pleasant [Node Package Manager](http://npmjs.org/). To download and set up the whole dependancies three, simply run from the project's root directory :\n\n    $ npm install\n\n### Environment variables\nThe following environment variables can be use with the highest priority :\n\n* **PORT** defines the port to listen to (ex: *80*);\n* **NODE_ENV** defines the runing mode (ex: *development*, *production*, etc);\n\n## Run\nTo launch the server (once the installation is complete), just run from the root of the project:\n\n```\n$ coffee app.coffee\n```\n\n## Create a page\n### Create a JSON file\nTo exist, every page must have a corresponding JSON file in the ```/data``` directory. For instance, the */exemple.html* is related to the file ```/data/exemple.json```.\n\n### JSON file structure\nSuch as a configuration file, the JSON file must fit to the following structure :\n\n```javascript\n// An array detailing every steps\n[\n    // Step configuration\n    {        \n        \"name\": \"name of the step\",\n        \"spots\": [ \n            // Spot configuration\n            {\n                \"top\":  \"0%\",\n                \"left\": \"50%\",\n                // ...\n            }\n        ],\n        // ...\n    }\n]\n```\n\n\u003ca name=\"steps\"/\u003e\n### Step configuration\nEvery step object can follow this options:\n\nName | Type | Description | Exemple |\n---- | ---- | ---- | ---- |\nname | String | Name of the step, displaying on the main menu and as the step's title | \"Soft kitty, warm kitty\"\nmenu-name | String | Alternative menu name (only displayed on the menu) | \"Soft kitty\" | \nno-index | Boolean | Set to true exit the step from the main menu. |\npicture | String | URL to an image file to display as \"background\", take the whole width. | \nstyle | String | Inline CSS to apply to the current step. | \"font-size:17px; color: red\"\nspots | Array | List of spots display in that step, see also [Spot configuration](#spots). |\nclass | String | One or serveral space-separated classes to put on the step | \"purr\"\n\n\u003ca name=\"spots\"/\u003e\n### Spot configuration\nEvery spot object can follow this options:\n\nName | Type | Description | Exemple |\n---- | ---- | ---- | ---- |\nhref | String | Href value of the hotspot. Can be an URL or an anchor. | \"#step=1\"\ntop | String | Top position of the spot from the top-left corner of the step. | \"10%\"\nleft | String | Left position of the spot from the top-left corner of the step. | \"20%\"\nwidth | String | Width of the spot. | \"100px\"\nheight | String | Height of the spot. Take the width value by default. | \"auto\"\ntitle | String | Title of the spot, display at its head. | \"Little ball of fur\"\nsub-title | String  | Sub-title of the spot, display bellow the title. | \"Happy kitty, sleepy kitty\"\npicture | Object | A picture to dispay bellow the sub-title. Taken to properties: ```src```and ```alt``` |\nstyle | String | Inline CSS to apply to the current spot. | \"font-size:17px; color: red\"\nclass | String | One or serveral space-separated classes to put on the spot. | \"purr\"\nentrance | String | Animates the entrance of the spot when a step the get the focus. See also [#entrances](Entrance animation) | \"zoomIn\", \"left down\", etc\nentrance-duration | Integer | Duration of the entrance animation. Default to 300. | 1000\nqueue | Boolean | If true, the spot wait the end of the previous spot's entrance to appear. |\nbackground | String | URL to an image file to display as background of the step |\nbackground-direction | String, Number | Animate the background into that direction in a loop. Can be a number to specify a dicrection in degree. | \"left\", 90, \"top left\", etc\nbackground-speed | Number | Distance in pixels to run through at each animation step. 3 by default. | 10\nbackground-frequency | Number | Animation step frequency in millisecond. 0 by default. | 200\n\n\n\u003ca name=\"entrances\"/\u003e\n### Entrance animations\nTo animate the entrance of a spot, you can use one or several of the following animation class :\n\nName | Description\n---- | ----\nleft | Sliding to the left\nright | Sliding to the right\nup | Sliding to the top\ndown | Sliding to the bottom\nzoomIn | Zoom in (getting bigger)\nzoomOut | Zoom out (getting smaller)\nfadeIn | Fading entrance\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjplusplus%2Fidf-interactive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjplusplus%2Fidf-interactive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjplusplus%2Fidf-interactive/lists"}