Skip to content

Commit 77150ad

Browse files
.
0 parents  commit 77150ad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+21221
-0
lines changed

CHANGELOG.md

Lines changed: 623 additions & 0 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
# Report an Issue
3+
4+
Help us make UI-Router better! If you think you might have found a bug, or some other weirdness, start by making sure
5+
it hasn't already been reported. You can [search through existing issues](https://github.com/angular-ui/ui-router/search?q=wat%3F&type=Issues)
6+
to see if someone's reported one similar to yours.
7+
8+
If not, then [create a plunkr](http://bit.ly/UIR-Plunk) that demonstrates the problem (try to use as little code
9+
as possible: the more minimalist, the faster we can debug it).
10+
11+
Next, [create a new issue](https://github.com/angular-ui/ui-router/issues/new) that briefly explains the problem,
12+
and provides a bit of background as to the circumstances that triggered it. Don't forget to include the link to
13+
that plunkr you created!
14+
15+
**Note**: If you're unsure how a feature is used, or are encountering some unexpected behavior that you aren't sure
16+
is a bug, it's best to talk it out on
17+
[StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) before reporting it. This
18+
keeps development streamlined, and helps us focus on building great software.
19+
20+
21+
Issues only! |
22+
-------------|
23+
Please keep in mind that the issue tracker is for *issues*. Please do *not* post an issue if you need help or support. Instead, see one of the above-mentioned forums or [IRC](irc://irc.freenode.net/#angularjs). |
24+
25+
####Purple Labels
26+
A purple label means that **you** need to take some further action.
27+
- ![Not Actionable - Need Info](ngdoc_assets/incomplete.png): Your issue is not specific enough, or there is no clear action that we can take. Please clarify and refine your issue.
28+
- ![Plunkr Please](ngdoc_assets/example.png): Please [create a plunkr](http://bit.ly/UIR-Plunk)
29+
- ![StackOverflow](ngdoc_assets/so.png): We suspect your issue is really a help request, or could be answered by the community. Please ask your question on [StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router). If you determine that is an actual issue, please explain why.
30+
31+
If your issue gets labeled with purple label, no further action will be taken until you respond to the label appropriately.
32+
33+
# Contribute
34+
35+
**(1)** See the **[Developing](#developing)** section below, to get the development version of UI-Router up and running on your local machine.
36+
37+
**(2)** Check out the [roadmap](https://github.com/angular-ui/ui-router/milestones) to see where the project is headed, and if your feature idea fits with where we're headed.
38+
39+
**(3)** If you're not sure, [open an RFC](https://github.com/angular-ui/ui-router/issues/new?title=RFC:%20My%20idea) to get some feedback on your idea.
40+
41+
**(4)** Finally, commit some code and open a pull request. Code & commits should abide by the following rules:
42+
43+
- *Always* have test coverage for new features (or regression tests for bug fixes), and *never* break existing tests
44+
- Commits should represent one logical change each; if a feature goes through multiple iterations, squash your commits down to one
45+
- Make sure to follow the [Angular commit message format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) so your change will appear in the changelog of the next release.
46+
- Changes should always respect the coding style of the project
47+
48+
49+
50+
# Developing
51+
52+
UI-Router uses <code>npm</code> and <code>webpack</code>.
53+
After cloning the ui-router repository, fetch the dependencies for building from source and running tests:
54+
55+
* run `$ npm install` from the project directory
56+
57+
There are a number of scripts in the package.json that are used to generate builds and run tests:
58+
59+
* `npm test`: runs the entire test suite.
60+
* `npm run build`: Perform a full build.
61+
* `npm run watch`: Continuously runs the tests when source or tests change.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) 2013-2015 The AngularUI Team, Karsten Sperling
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AngularUI Router &nbsp;[![Build Status](https://travis-ci.org/angular-ui/ui-router.svg?branch=master)](https://travis-ci.org/angular-ui/ui-router)
2+
3+
**Note: this is the Angular 1.x source for UI-Router version 1.0. If you are looking for the source for UI-Router
4+
version 0.2.x, it can be found [here](https://github.com/angular-ui/ui-router/tree/legacy)**
5+
6+
---
7+
8+
9+
#### The de-facto solution to flexible routing in angular
10+
---
11+
**[Tutorials](https://ui-router.github.io/tutorials/)** |
12+
**[API Docs](https://ui-router.github.io/docs/latest/)** |
13+
**[Download stable](http://unpkg.com/angular-ui-router@latest/release/angular-ui-router.js)** (or **[Minified](http://unpkg.com/angular-ui-router@latest/release/angular-ui-router.min.js)**) **|**
14+
**[Guide](https://github.com/angular-ui/ui-router/wiki) |**
15+
**[Sample App](http://ui-router.github.io/resources/sampleapp/) |**
16+
**[FAQ](https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions) |**
17+
**[Report an Issue](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#report-an-issue) |**
18+
**[Contribute](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#contribute) |**
19+
**[Help!](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) |**
20+
21+
---
22+
23+
Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application)
24+
routing framework for [AngularJS](http://angularjs.org).
25+
26+
Routing frameworks for SPAs update the browser's URL as the user navigates through the app. Conversely, this allows
27+
changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a
28+
___location deep within the SPA.
29+
30+
UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a
31+
[*state machine*](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those
32+
application states in a transaction-like manner.
33+
34+
## Get Started
35+
36+
37+
- [UI-Router for Angular 1](https://ui-router.github.io/ng1)
38+
- [UI-Router for Angular 2](https://ui-router.github.io/ng2)
39+
- [UI-Router for React](https://ui-router.github.io/react)
40+
41+
## Resources
42+
43+
* [In-Depth Guide](https://github.com/angular-ui/ui-router/wiki)
44+
* [Slides comparing ngRoute to ui-router](http://slid.es/timkindberg/ui-router#/)
45+
* [UI-Router Extras / Addons for legacy (0.x)](http://christopherthielen.github.io/ui-router-extras/#/home) (@christopherthielen)
46+
47+
### Videos
48+
49+
* [Introduction Video](https://egghead.io/lessons/angularjs-introduction-ui-router) (egghead.io)
50+
* [Tim Kindberg on Angular UI-Router](https://www.youtube.com/watch?v=lBqiZSemrqg)
51+
* [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
52+
* [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
53+
54+
## Reporting issues and Contributing
55+
56+
Please read our [Contributor guidelines](CONTRIBUTING.md) before reporting an issue or creating a pull request.

bower.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "angular-ui-router",
3+
"description": "State-based routing for AngularJS",
4+
"license": "MIT",
5+
"main": "./release/angular-ui-router.js",
6+
"dependencies": {
7+
"angular": ">= 1.2.0"
8+
},
9+
"ignore": [
10+
"**/.*",
11+
"**/tsconfig.json",
12+
"**/webpack.config.js",
13+
"**/node_modules",
14+
"**/ng2*",
15+
"**/typings",
16+
"commonjs",
17+
"bower_components",
18+
"component.json",
19+
"package.json",
20+
"lib",
21+
"config",
22+
"sample",
23+
"test",
24+
"tests",
25+
"ngdoc_assets",
26+
"Gruntfile.js",
27+
"files.js"
28+
],
29+
"version": "1.0.0-beta.2",
30+
"homepage": "https://ui-router.github.io"
31+
}

0 commit comments

Comments
 (0)