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

[WIP] Cleanup #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
6 changes: 6 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"parserOptions": {
"ecmaVersion": 6
},
"extends": "google"
}
95 changes: 56 additions & 39 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,41 +1,58 @@

# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
*.pyc

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
# Logs
logs
*.log
*.sql
*.db
*.sqlite
*.gexf
*.json

# OS generated files #
######################
.DS_Store
.DS_Store?
.Spotlight-V100
.Trashes
data/*
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@

### Presentation

Thank you for using ProjectExplorer/TinawebJS.
Thank you for using Tinaweb.

This work is lead by the Complex Systems Institute of Paris Ile-de-France ([ISCPIF](http://iscpif.fr)) and the [Centre d'Analyse et de Mathématique Sociales](http://cams.ehess.fr/), both [CNRS](http://www.cnrs.fr/) entities.

###### Source code repository
https://github.com/moma/ProjectExplorer
https://github.com/ISCPIF/tinaweb

###### Authors

Researchers and engineers of the [ISCPIF/CNRS - UPS 3611](http://iscpif.fr)
- Dr. David Chavalarias
This work is conducted under the supervision of Dr. David Chavalarias (CNRS, CAMS & ISC-PIF), with the following contributors to the development :
- Samuel Castillo
- Romain Loth

You can contact the authors by email (<firstname.lastname@iscpif.fr>).
You can contact us by email (<firstname.lastname@iscpif.fr>).

###### Acknowledgements
- TinawebJS is build on top of Alexis Jacomy and Guillaume Plique's [sigmaJS](http://sigmajs.org)
Expand All @@ -28,21 +27,21 @@ You can contact the authors by email (<firstname.lastname@iscpif.fr>).

### Usage

ProjectExplorer is a versatile app that can be used as standalone or as a client library. The documentation concerning the different setup cases is being updated after a major refactoring and will grow in time.
Tinaweb is a versatile app that can be used as standalone or as a client library. The documentation concerning the different setup cases is being updated after a major refactoring and will grow in time.

Here are the main points.

###### Getting started
In the simplest setup, just clone the repository and open explorerjs.html in a modern browser.
```
git clone https://github.com/moma/ProjectExplorer.git
cd ProjectExplorer
git clone git@github.com:ISCPIF/tinaweb.git
cd tinaweb
firefox explorerjs.html
```
=> An input in the upper right side allows you to open any gexf file.
[]
###### Application and data structures
An overview of the application structure can be found in the extended documentation under [00.DOCUMENTATION/A-Introduction/app_structure.md](https://github.com/moma/ProjectExplorer/blob/master/00.DOCUMENTATION/A-Introduction/app_structure.md) (comments are in french).
An overview of the application structure can be found in the extended documentation under [00.DOCUMENTATION/A-Introduction/app_structure.md](https://github.com/ISCPIF/tinaweb/blob/master/00.DOCUMENTATION/A-Introduction/app_structure.md) (comments are in french).

###### Usage on a web server
To activate all features, you should:
Expand All @@ -59,14 +58,14 @@ Once you have this webserver running and some source data files, you may also co
- it will be shown as a **menu** to select graphs in the interface
- it allows to define associated **node types** for each source
- it allows to define associated **search backends** for each source
- to use this, follow the guidelines in the **[Project config HOWTO](https://github.com/moma/ProjectExplorer/blob/master/00.DOCUMENTATION/A-Introduction/project_config.md)**
- to use this, follow the guidelines in the **[Project config HOWTO](https://github.com/ISCPIF/tinaweb/blob/master/00.DOCUMENTATION/A-Introduction/project_config.md)**

###### Integration in a larger app
To integrate ProjectExplorer in a larger web application, you may have several locations with subdirectories defined on your server. In this case, you'll need to use the provided path modification tool (see this [integration procedure example](https://github.com/moma/ProjectExplorer/tree/master/00.DOCUMENTATION/A-Introduction#integration-policy))
To integrate ProjectExplorer in a larger web application, you may have several locations with subdirectories defined on your server. In this case, you'll need to use the provided path modification tool (see this [integration procedure example](https://github.com/ISCPIF/tinaweb/tree/master/00.DOCUMENTATION/A-Introduction#integration-policy))

###### Advanced settings
For more information about ProjectExplorer's settings (settings file, input modes, attribute processing options), please refer to the [detailed introduction](https://github.com/moma/ProjectExplorer/blob/master/00.DOCUMENTATION/A-Introduction/README.md)
and the [developer's manual](https://github.com/moma/ProjectExplorer/blob/master/00.DOCUMENTATION/C-advanced/developer_manual.md).
For more information about ProjectExplorer's settings (settings file, input modes, attribute processing options), please refer to the [detailed introduction](https://github.com/ISCPIF/tinaweb/blob/master/00.DOCUMENTATION/A-Introduction/README.md)
and the [developer's manual](https://github.com/ISCPIF/tinaweb/blob/master/00.DOCUMENTATION/C-advanced/developer_manual.md).

### Copyright and license

Expand Down
24 changes: 24 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "tinaweb",
"version": "1.0.0",
"description": "TODO",
"main": "settings_explorerjs.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"lint": "eslint **/*.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/ISCPIF/tinaweb.git"
},
"author": "",
"license": "GPL-3.0",
"bugs": {
"url": "https://github.com/ISCPIF/tinaweb/issues"
},
"homepage": "https://github.com/ISCPIF/tinaweb#readme",
"devDependencies": {
"eslint": "^4.9.0",
"eslint-config-google": "^0.9.1"
}
}
Loading