Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GPII-4253: Created initial gpii stubs for non-supported OSs #1

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
BSD 3-Clause License

Copyright (c) 2019, Global Public Inclusive Infrastructure
All rights reserved.
Copyright (c) 2012-2019 Members of the Raising the Floor Consortium.
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
3. Neither the name of the copyright holder nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Expand All @@ -26,4 +24,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# GPII "no-os" stubs

Contains stubs for platform-specific components of the GPII architecture. See [http://gpii.net/](http://gpii.net/) for
overall details of the GPII project. After checkout using git, this project will require node.js and npm to be
installed - please consult [Setting Up Your Development Environment](http://wiki.gpii.net/w/Setting_Up_Your_Development_Environment)
for installation instructions.

This module exists to support developers who are porting Morphic to new operating systems. When adding support for a new operating
system, this "no-os" module can be used as the basis for that OS's new platform-specific module.

## Building the "no-os" stubs

This package depends on node 6.x (LTS).

To build the no-os stubs for GPII, perform the following:

git clone https://github.com/GPII/gpii-no-os.git
cd gpii-no-os
npm install

31 changes: 31 additions & 0 deletions gpii.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* GPII "No OS" Personalization Framework Node.js Bootstrap
*
* Copyright 2019 Raising the Floor -- US Inc. All rights reserved.
* Copyright 2012 OCAD University
*
* Licensed under the New BSD license. You may not use this file except in
* compliance with this License.
*
* You may obtain a copy of the License at
* https://github.com/GPII/universal/blob/master/LICENSE.txt
*
* The R&D leading to these results received funding from the
* Department of Education - Grant H421A150005 (GPII-APCP). However,
* these results do not necessarily represent the policy of the
* Department of Education, and you should not assume endorsement by the
* Federal Government.
*
* The research leading to these results has received funding from the European Union's
* Seventh Framework Programme (FP7/2007-2013)
* under grant agreement no. 289016.
*/

"use strict";

var fluid = require("gpii-universal"),
gpii = fluid.registerNamespace("gpii");

require("./index.js");

gpii.start();
28 changes: 28 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* GPII Universal Personalization Framework GPII "no-os" Index
*
* Copyright 2019 Raising the Floor -- US Inc. All rights reserved.
* Copyright 2014 Lucendo Development Ltd.
*
* Licensed under the New BSD license. You may not use this file except in
* compliance with this License.
*
* You may obtain a copy of the License at
* https://github.com/GPII/universal/blob/master/LICENSE.txt
*
* The R&D leading to these results received funding from the
* Department of Education - Grant H421A150005 (GPII-APCP). However,
* these results do not necessarily represent the policy of the
* Department of Education, and you should not assume endorsement by the
* Federal Government.
*
* The research leading to these results has received funding from the European Union's
* Seventh Framework Programme (FP7/2007-2013)
* under grant agreement no. 289016.
*/

"use strict";

var fluid = require("gpii-universal");

module.exports = fluid;
31 changes: 31 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "gpii-no-os",
"description": "Stub definitions suitable for booting up the GPII Morphic UI implemented in gpii-app without platform-specific support",
"version": "0.3.0",
"author": "Raising the Floor -- US Inc.",
"bugs": {
"url": "http://issues.gpii.net/browse/GPII"
},
"homepage": "http://gpii.net/",
"scripts": {
"test": "exit 0"
},
"dependencies": {
"gpii-universal": "JavierJF/universal#GPII-3810"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this branch rather than master or, even better, an npm artefact?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency, this is the same branch used by the Windows repository.
https://github.com/GPII/windows/blob/master/package.json

I can change it to any other repo/package/branch, as desired. To date, I have been testing specifically with the branch used by GPII/windows.

},
"os": [
"!win32"
],
"license": "BSD-3-Clause",
"keywords": [
"gpii"
],
"repository": {
"type": "git",
"url": "git+https://github.com/GPII/gpii-no-os.git"
},
"main": "./gpii.js",
"engines": {
"node": ">=6.3.1"
}
}