Skip to content

Commit

Permalink
update readme with the link of the ultrateam project for example
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoSecteur4 committed Apr 9, 2018
0 parents commit 54b1600
Show file tree
Hide file tree
Showing 29 changed files with 4,276 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[{package,bower}.json]
indent_style = space
indent_size = 2
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
coverage
generators/**/templates
node_modules
travis
31 changes: 31 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"env": {
"node": true,
"es6": true
},
"extends": ["airbnb-base"],
"rules": {
"indent": [2, 4],
"linebreak-style": 0,
"eol-last": 2,
"quotes": [2, "single"],
"semi": [2, "always"],
"eqeqeq": [2, "smart"],
"no-use-before-define": [2, "nofunc"],
"no-unused-vars": [2, {"vars": "local", "args": "none"}],
"no-multi-str": 2,
"no-irregular-whitespace": 2,
"comma-dangle": "off",
"max-len": "off",
"func-names": "off",
"class-methods-use-this": "off",
"no-underscore-dangle": "off",
"no-plusplus": "off",
"no-unused-expressions": [2, { "allowShortCircuit": true, "allowTernary": true } ],
"prefer-destructuring": "off",

"no-multi-assign": "off",
"no-param-reassign": "off",
"no-shadow": "off"
}
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
15 changes: 15 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
os:
- linux
language: node_js
node_js:
- "8.9.1"
before_install:
- npm install -g npm
# Repo for Yarn
- curl -o- -L https://yarnpkg.com/install.sh | bash
- export PATH=$HOME/.yarn/bin:$PATH
install:
- yarn install
- yarn link
script:
- yarn test
10 changes: 10 additions & 0 deletions .yo-rc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"generator-jhipster-module": {
"promptValues": {
"githubName": "HugoSecteur4",
"authorName": "Hugo Gros-Daillon & Bastien Terrier",
"authorEmail": "gdahugo@gmail.com",
"authorUrl": ""
}
}
}
25 changes: 25 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
The generation of the leaflet map was realized with the tutorial : https://www.asymmetrik.com/ngx-leaflet-tutorial-angular-cli/

this includes the license :

The MIT License (MIT)

Copyright (c) 2007-2017 Asymmetrik Ltd, a Maryland Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
118 changes: 118 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# generator-jhipster-leafletmap
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> JHipster module, This module generates a leaflet map in a new page of a monolithic jhipster application (4.14.1 with Angular and TypeScript).
Generator realized by Hugo GROS-DAILLON and Bastien TERRIER

# Introduction

This is a [JHipster](http://jhipster.github.io/) module, that is meant to be used in a JHipster application.

# Example

Here (https://github.com/ultratrail/Hiking-Demo) you can download a JHipster project that uses leaflet maps with angular 5. (UltraTeam 7.1 realized by Hugo GROS-DAILLON and Bastien TERRIER)

# Prerequisites

As this is a [JHipster](http://jhipster.github.io/) module, we expect you have JHipster and its related tools already installed:

- [Installing JHipster](https://jhipster.github.io/installation.html)

# Installation

## With NPM

To install this module:

```bash
npm install -g generator-jhipster-leafletmap
```

To update this module:

```bash
npm update -g generator-jhipster-leafletmap
```
## With github

Clone the project on :

https://github.com/ultratrail/generator-jhipster-leafletmap

# Usage

## With the NPM Installation

1) Go into your jhipster application path (with cd)

2) Execute:
```bash
yo jhipster-leafletmap
```

3) Press ENTER when the generator ask to you the first question.

## If you cloned the project from github

1) Go into the project path with the shell (with cd)

2) Execute:
```bash
yarn install
```

3) Execute:
```bash
yarn link
```

4) Go into your jhipster application path

5) Execute:
```bash
yarn link generator-jhipster-leafletmap
```

6) Execute:
```bash
yo jhipster-leafletmap
```

7) Press ENTER when the generator ask to you the first question.

# License

The generation of the leaflet map was realized with the tutorial : https://www.asymmetrik.com/ngx-leaflet-tutorial-angular-cli/

this includes the license :

The MIT License (MIT)

Copyright (c) 2007-2017 Asymmetrik Ltd, a Maryland Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.




[npm-image]: https://img.shields.io/npm/v/generator-jhipster-leafletmap.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-leafletmap
[travis-image]: https://travis-ci.org/HugoSecteur4/generator-jhipster-leafletmap.svg?branch=master
[travis-url]: https://travis-ci.org/HugoSecteur4/generator-jhipster-leafletmap
[daviddm-image]: https://david-dm.org/HugoSecteur4/generator-jhipster-leafletmap.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/HugoSecteur4/generator-jhipster-leafletmap
10 changes: 10 additions & 0 deletions VERSIONS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
This generator works with :

- Jhipster version 4.14.1
- leaflet version 1.3.1
- @types/leaflet version 1.2.6
- @asymmetrik/ngx-leaflet version 3.0.2

In the file generators/app/index.js, in lines 295, 296 and 297
are installed the dependencies. You can update them manually
if new versions are released.
Loading

0 comments on commit 54b1600

Please sign in to comment.