Skip to content

Commit

Permalink
Revamping the base to use grunt so the project is a little easier to …
Browse files Browse the repository at this point in the history
…maintain. See CONTRIBUTING.md for updated instructions.

1. Switched to using Grunt to build source code. JS files in `./dist` are now generated from `./src` folder.

2. Moved source files to `./src` folder

3. Renamed `./samples` to `./examples`

4. Renamed `./jqvmap` to `./dist`

5. Removed `./website` folder as it is not really needed in this project

6. Updated `README.md` & `CONTRIBUTING.md` files
  • Loading branch information
manifestinteractive committed Nov 18, 2015
1 parent ef7f9c6 commit a510313
Show file tree
Hide file tree
Showing 146 changed files with 2,481 additions and 6,773 deletions.
5 changes: 4 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"globals": {
"jQuery": true
"jQuery": true,
"WorldMap": true,
"VectorCanvas": true,
"ColorScale": true
},
"env": {
"browser": true
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@
syntax: glob

!.gitignore
.DS_Store
Thumbs.db
.idea
node_modules
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@
Change Log
======

Version 1.2.0
---

`Released on November 18th, 2015`

1. Switched to using Grunt to build source code. JS files in `./dist` are now generated from `./src` folder.

2. Moved source files to `./src` folder

3. Renamed `./samples` to `./examples`

4. Renamed `./jqvmap` to `./dist`

5. Removed `./website` folder as it is not really needed in this project

6. Updated `README.md` & `CONTRIBUTING.md` files

Version 1.1.0
---

Expand Down
87 changes: 76 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,82 @@ Contributing to JQVMap

Please review the following if you intend to submit an issue or pull request. Not following the guidelines below most likely means your submission will be rejected.

Reporting an Issue
---

**ATTENTION:** While creating tickets is the only way to assign a task to be completed, it is equally important to not flood the development team with tickets that are not actually necessary ( might be a duplicate, already being worked on, not actually an issue, etc ). So before you create a ticket, please check that your issue has not already been reported.

#### Creating a New Issue

To submit a ticket, visit the project's repo on [Github](https://github.com/manifestinteractive/jqvmap), select the **Issues** tab in the right column, and click the green **New issue** button.

**Please use our [Ticket Template](https://github.com/manifestinteractive/culture/blob/master/templates/ticket-template.md) to make sure you are entering all the information we will need to complete the item you are about to create.**

Map Specific Issues
---

Please note that the JQVMap team does not make the maps, nor will we make any modifications to maps that have been contributed. If there is an issue with the map, you are more than welcome to update the map within your project.

Making Code Changes
---

All source code for this project is contained in the `./src` folder. Do not make any changes to the javascript files in the `./dist` folder, these are automatically generated by the `grunt build` terminal command. Any Pull Requests that were not generated using the following Grunt Terminal Commands will be automatically rejected in order to maintain structural integrity of this project.

#### Requirements

* [Node.js v0.10](http://nodejs.org/) ( For Application Development )

Grunt Terminal Commands:
---

You can use the following build commands via terminal:

#### Build for Distribution:

The following command will Concat JS files and generate minified files for Distribution.

This is the most common command you will want to use and is required to view any changes you made in a browser.

```bash
grunt build
```

#### Create a Major Release:

The following will:

1. Increase the build's major number ( e.g. v __1__.0.1 => v __2__.0.0 )
2. Build & Package Distribution Files
3. Perform a git commit

```bash
grunt release-major
```

#### Create a Minor Release:

The following will:

1. Increase the build's minor number ( e.g. v 1.__0__.1 => v 1.__1__.0 )
2. Build & Package Distribution Files
3. Perform a git commit

```bash
grunt release-minor
```

#### Create a Release Patch:

The following will:

1. Increase the build's patch number ( e.g. v 1.1.__1__ => v 1.1.__2__ )
2. Build & Package Distribution Files
3. Perform a git commit

```bash
grunt release-patch
```

Submitting a Pull Request
---

Expand Down Expand Up @@ -40,14 +116,3 @@ All Pull Requests must be reviewed by one of your peers before it can be merged
8. If you are 100% certain you will never need that branch again, you can delete the branch after merging into master
9. Contact the PR Author and let them know the results of your review
10. Stay on top of any PR's you are reviewing until they are able to be successfully merged into master

Reporting an Issue
---

**ATTENTION:** While creating tickets is the only way to assign a task to be completed, it is equally important to not flood the development team with tickets that are not actually necessary ( might be a duplicate, already being worked on, not actually an issue, etc ). So before you create a ticket, please check that your issue has not already been reported.

#### Creating a New Item

To submit a ticket, visit the project's repo on [Github](https://github.com/manifestinteractive/jqvmap), select the **Issues** tab in the right column, and click the green **New issue** button.

**Please use our [Ticket Template](https://github.com/manifestinteractive/culture/blob/master/templates/ticket-template.md) to make sure you are entering all the information we will need to complete the item you are about to create.**
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
![JQVMap](http://jqvmap.com/img/logo.png "JQVMap")

This project is a heavily modified version of [jVectorMap](https://github.com/bjornd/jvectormap). I chose to start fresh rather than fork their project as my intentions were to take it in such a different direction that it would become incompatibale with the original source, rendering it near impossible to merge our projects together without extreme complications.
This project is a heavily modified version of [jVectorMap](https://github.com/bjornd/jvectormap) as it was in April of 2012. I chose to start fresh rather than fork their project as my intentions were to take it in such a different direction that it would become incompatibale with the original source, rendering it near impossible to merge our projects together without extreme complications.

**Tests:** [![Circle CI](https://circleci.com/gh/manifestinteractive/jqvmap/tree/master.svg?style=svg&circle-token=7bce3b80868ea5ca32009a195c4436db91e5ea67)](https://circleci.com/gh/manifestinteractive/jqvmap/tree/master)


jQuery Vector Map
======

To get started, all you need to do is include the JavaScript and CSS files for the map you want to load. Here is a sample HTML page for loading the World Map with default settings:
To get started, all you need to do is include the JavaScript and CSS files for the map you want to load ( contained in the `./dist` folder ).

#### Here is a sample HTML page for loading the World Map with default settings:

```html
<html>
<head>
<title>JQVMap - World Map</title>
<link href="../jqvmap/jqvmap.css" media="screen" rel="stylesheet" type="text/css">
<link href="../dist/jqvmap.css" media="screen" rel="stylesheet" type="text/css">

<script type="text/javascript" src="http://code.jquery.com/jquery-1.11.3.min.js"></script>
<script type="text/javascript" src="../jqvmap/jquery.vmap.js"></script>
<script type="text/javascript" src="../jqvmap/maps/jquery.vmap.world.js" charset="utf-8"></script>
<script type="text/javascript" src="../dist/jquery.vmap.js"></script>
<script type="text/javascript" src="../dist/maps/jquery.vmap.world.js" charset="utf-8"></script>

<script type="text/javascript">
jQuery(document).ready(function() {
Expand Down Expand Up @@ -66,6 +68,11 @@ jQuery('#vmap').vectorMap(
});
```

More Examples
------

You can see a variety of examples in the `./examples` folder.

Configuration Settings
------

Expand Down
19 changes: 11 additions & 8 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
{
"name": "jqvmap",
"version": "1.1.0",
"homepage": "http://jqvmap.com/",
"homepage": "http://jqvmap.com",
"authors": [
"Manifest Interactive <info@manifestinteractive.com>"
"Peter Schmalfeldlt <me@peterschmalfeldt.com>"
],
"dependencies": {
"jquery": "~1.10.2"
},
"license": "(MIT OR GPL-3.0)",
"description": "jQuery Vector Map Library",
"main": "jqvmap/jquery.vmap.min.js",
"main": "dist/jquery.vmap.min.js",
"keywords": [
"jquery",
"map",
"svg",
"vml",
"vector"
],
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/manifestinteractive/jqvmap.git"
},
"dependencies": {
"jquery": "~1.11.3"
},
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"app/components",
"test",
"tests"
]
Expand Down
Loading

0 comments on commit a510313

Please sign in to comment.