A digital library of stories, created collaboratively by Deaf and hearing people for Deaf children and their families, the school community, and the Deaf community. It is a web platform designed to make collaboration easy for uploading and editing contents for reading and viewing. It provides a space to watch, read, interact, like, share, comment, upload, and edit the contents.
This repo holds the style guides, wireframes, and prototype implementation of the reader's view, beginning with Filipino Sign Language (FSL).
In the reader's view, each dot along the main slider bar represents a page in the story. Each page has 3 components, or sub-pages: 1) photo, 2) signed video, and 3) glossary interactivity. A sample story is shown in this prototype: "Malakas and Maganda."
All dependencies are included. This prototype can run offline.
- nodejs (https://nodejs.org/en/)
- mysql database
- git (https://git-scm.com/downloads)
- FFmpeg (https://www.ffmpeg.org/download.html)
|_ data_templates - Template describing how the JSON data is structured
|
|_ fonts - Font files
|
|_ html
|_ Client - Html templates used but the front end javascript
|_ Games - Folder to hold the directories for each game added to the website. Each game should be in it's own directory and contain a Editor.js and Main.js file for editing and launching the game.
|_ Server - Html templates used but the back end javascript
|
|_ img - Images used in the website
|
|_ js
|_ Client - Javascript files use in the front end of the website
|_ Offline - Javascript files use for when the site is offline
|_ Server - Javascript files use by the backed nodejs server
|_ _Settings.js - Base server settings file. Copy this file and name it "Settings.js" before starting the server
|
|_ style - CSS files for the website
|
|_ uploads - (git ignored folder) The image and video files uploaded by users for the stories
|
|_ Server.js - Main file for nodejs server. (run this file in node to start the server)
|
|_ BuildOfflineFiles.js Node script to build the files required for the offline viewer
|
|_ database.sql - Sql query to run to created the database for the site. Run this before starting the server.
- Download and install nodejs
- Download and install git
- Download FFmpeg and add it to your path
- Setup a mysql server
- In a command line console navigate to the repository
- Install all the node dependencies by running the following commands:
- npm install
- npm install jspm -g
- jspm install
- Create you database using the database.sql file
- Copy the file "js/Server/_Settings.js" file and name the new copy "js/Server/Settings.js"
- Edit the contents of the new Settings.js file to match the specifications of your server
- In the command line run node Server.js to start the server
- Create a new folder for your game in the 'js/Client/Games/' directory.
- In the database add an entry into the 'game' table for your game. The 'name' field is the name that will appear in the site, the 'path' field should be the name of the directory added in step 1.
- In the directory create 2 files 'Editor.js' and 'Main.js', to be used for editing and running the game respectively.
When your editor is lauch it will have access to a global "game" object which will include relevate information like the id of the gamedata, the story data, the languages of the game, and any previously save game data.
{
id: int,
story: object,
writtenLanguage: string,
signLanguage: string,
data: object or null
}
In your Editor.js file, game data is save as a json string in the database and must include a propety called 'name' for display purposes. The api call to save game data is (post: /api/story/gamedata) and the data should be formatted to include the following:
{
id: the id of the game data found in the url
data: object that stores the game data
}
If needed the the api call to get game data is (get: api/game/data?id={the id of the game data}).
Just like in the editor, you will have access to a global 'game' object wit the same properties as described above.