Skip to content

Commit

Permalink
added examples for electron, updated examples for webpack and ts
Browse files Browse the repository at this point in the history
  • Loading branch information
ujjwalguptaofficial committed May 16, 2018
1 parent 8c472fd commit 72cf6e9
Show file tree
Hide file tree
Showing 32 changed files with 9,421 additions and 93 deletions.
2 changes: 1 addition & 1 deletion examples/TypeScript Example/dist/index.html
@@ -1 +1 @@
<!DOCTYPE html><html><head><title>jsstore example</title></head><body><div id="divContainer"><table id="tblStudents"><thead><tr><th>Name</th><th>Gender</th><th>Country</th><th>City</th><th></th><th></th></tr></thead><tbody></tbody></table></div><script src="scripts/bundle.js?c87fed3290c02d743e50"></script></body></html>
<!DOCTYPE html><html><head><title>jsstore example</title></head><body><div id="divContainer"><table id="tblStudents"><thead><tr><th>Name</th><th>Gender</th><th>Country</th><th>City</th><th></th><th></th></tr></thead><tbody></tbody></table></div><script src="scripts/bundle.js?d8b9b707c1651d8598ca"></script></body></html>
6 changes: 3 additions & 3 deletions examples/TypeScript Example/dist/scripts/bundle.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions examples/TypeScript Example/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/TypeScript Example/package.json
Expand Up @@ -6,7 +6,7 @@
},
"dependencies": {
"jquery": "^3.3.1",
"jsstore": "^2.0.0"
"jsstore": "^2.0.5"
},
"devDependencies": {
"css-loader": "^0.28.11",
Expand Down
Expand Up @@ -6,7 +6,6 @@ export class StudentLogic {
private service_ = new StudentService();

constructor() {
this.service_.createDb();
this.registerEvents_();
}

Expand Down
50 changes: 46 additions & 4 deletions examples/TypeScript Example/src/code/service/base_service.ts
@@ -1,13 +1,55 @@
import { IdbHelper } from "./idb_helper";
import { idbCon } from "./idb_helper";

import { IError, ITable, Column, COL_OPTION, DATA_TYPE, IDataBase } from 'jsstore';

export class BaseService {

isDbExist(dbName) {
return this.connection.isDbExist(dbName);
private dbName_ = "Ts_Student_Demo";

constructor() {
// initiate database when a service instance is initiated
this.initDatabase();
}

/**
* create database
*
* @memberof IdbService
*/
initDatabase() {
this.connection.isDbExist(this.dbName_).then((exist: boolean) => {
if (exist) {
this.connection.openDb(this.dbName_);
}
else {
this.connection.createDb(this.getDatabase_());
}
}).catch((err: IError) => {
console.error(err);
});
}

private getDatabase_() {
const tblStudent: ITable = {
name: 'Students',
columns: [
new Column('id').options([COL_OPTION.PrimaryKey, COL_OPTION.AutoIncrement]),
new Column('name').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String),
new Column('gender').options([COL_OPTION.NotNull]).disableSearch(),
new Column('country').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String),
new Column('city').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String)
]
};
const database: IDataBase = {
name: this.dbName_,
tables: [tblStudent]
};

return database;
}

get connection() {
return IdbHelper.idbCon;
return idbCon;
}

}
4 changes: 1 addition & 3 deletions examples/TypeScript Example/src/code/service/idb_helper.ts
Expand Up @@ -2,6 +2,4 @@ import * as JsStore from 'jsstore';
import * as workerPath from "file-loader?name=scripts/[name].[hash].js!jsstore/dist/jsstore.worker.js";
// This will ensure that we are using only one instance.
// Otherwise due to multiple instance multiple worker will be created.
export class IdbHelper {
static idbCon = new JsStore.Instance(new Worker(workerPath));
}
export const idbCon = new JsStore.Instance(new Worker(workerPath));
41 changes: 1 addition & 40 deletions examples/TypeScript Example/src/code/service/student_service.ts
@@ -1,28 +1,8 @@
import { BaseService } from './base_service';
import { IError, ITable, Column, COL_OPTION, DATA_TYPE, IDataBase } from 'jsstore';
import { Student } from '../model/student';

export class StudentService extends BaseService {
private dbName_ = "Ts_Student_Demo";

/**
* create database
*
* @memberof IdbService
*/
createDb() {
this.connection.isDbExist(this.dbName_).then((exist: boolean) => {
if (exist) {
this.connection.openDb(this.dbName_);
}
else {
this.connection.createDb(this.getDatabase_());
}
}).catch((err: IError) => {
console.error(err);
});
}


getStudents() {
return this.connection.select<Student>({
from: 'Students'
Expand Down Expand Up @@ -63,23 +43,4 @@ export class StudentService extends BaseService {
}
});
}

private getDatabase_() {
const tblStudent: ITable = {
name: 'Students',
columns: [
new Column('id').options([COL_OPTION.PrimaryKey, COL_OPTION.AutoIncrement]),
new Column('name').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String),
new Column('gender').options([COL_OPTION.NotNull]).disableSearch(),
new Column('country').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String),
new Column('city').options([COL_OPTION.NotNull]).setDataType(DATA_TYPE.String)
]
};
const database: IDataBase = {
name: this.dbName_,
tables: [tblStudent]
};

return database;
}
}
2 changes: 2 additions & 0 deletions examples/electron/.gitignore
@@ -0,0 +1,2 @@
node_modules
dist
39 changes: 39 additions & 0 deletions examples/electron/LICENSE.md
@@ -0,0 +1,39 @@
CC0 1.0 Universal
==================

Statement of Purpose
---------------------

The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.

For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights.
--------------------------------
A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.

2. Waiver.
-----------
To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback.
----------------------------
Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.

4. Limitations and Disclaimers.
--------------------------------

a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.
45 changes: 45 additions & 0 deletions examples/electron/README.md
@@ -0,0 +1,45 @@
# electron-quick-start

**Clone and run for a quick way to see Electron in action.**

This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start) within the Electron documentation.

**Use this app along with the [Electron API Demos](https://electronjs.org/#get-started) app for API code examples to help you get started.**

A basic Electron application needs just these files:

- `package.json` - Points to the app's main file and lists its details and dependencies.
- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
- `index.html` - A web page to render. This is the app's **renderer process**.

You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start).

## To Use

To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash
# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start
```

Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.

## Resources for Learning Electron

- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation
- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs

## License

[CC0 1.0 (Public Domain)](LICENSE.md)

0 comments on commit 72cf6e9

Please sign in to comment.