Skip to content

Commit a51435d

Browse files
Initial commit
0 parents  commit a51435d

12 files changed

+449
-0
lines changed

.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
[*]
3+
end_of_line = lf
4+
insert_final_newline = true
5+
6+
[*.js]
7+
charset = utf-8
8+
indent_style = space
9+
indent_size = 2
10+
continuation_indent_size = 6
11+

.eslintrc.js

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
module.exports = {
2+
"env": {
3+
"browser": true,
4+
"es6": true
5+
},
6+
"extends": "eslint:recommended",
7+
"parserOptions": {
8+
"sourceType": "module",
9+
"ecmaVersion": 2017
10+
},
11+
"rules": {
12+
"indent": [
13+
"error",
14+
4
15+
],
16+
"linebreak-style": [
17+
"error",
18+
"unix"
19+
],
20+
"quotes": [
21+
"error",
22+
"single"
23+
],
24+
"semi": [
25+
"error",
26+
"never"
27+
]
28+
}
29+
};

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.DS_Store
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
7+
# ignore all files starting with . or ~
8+
.*
9+
~*
10+
11+
# ignore node/grunt dependency directories
12+
node_modules/
13+
14+
# ignore log files
15+
*.log
16+
17+
# -------------------------
18+
# BEGIN Whitelisted Files
19+
# -------------------------
20+
21+
# track these files, if they exist
22+
!.gitignore
23+
!.editorconfig
24+
!.eslintrc.js

CODE_OF_CONDUCT.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Open Source Code Of Conduct
2+
3+
This code of conduct outlines our expectations for participants within the Modus Create community, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates this code of conduct may be banned from the community.
4+
5+
Our open source community strives to:
6+
7+
#### Be friendly and patient.
8+
9+
#### Be welcoming
10+
11+
We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
12+
13+
#### Be considerate
14+
15+
Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we’re a world-wide community, so you might not be communicating in someone else’s primary language.
16+
17+
#### Be respectful
18+
19+
Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one.
20+
Be careful in the words that you choose: we are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren’t acceptable. This includes, but is not limited to:
21+
22+
* Violent threats or language directed against another person.
23+
* Discriminatory jokes and language.
24+
* Posting sexually explicit or violent material.
25+
* Posting (or threatening to post) other people’s personally identifying information (“doxing”).
26+
* Personal insults, especially those using racist or sexist terms.
27+
* Unwelcome sexual attention.
28+
* Advocating for, or encouraging, any of the above behavior.
29+
* Repeated harassment of others. In general, if someone asks you to stop, then stop.
30+
31+
#### When we disagree, try to understand why
32+
33+
Disagreements, both social and technical, happen all the time. It is important that we resolve disagreements and differing views constructively.
34+
35+
#### Remember that we’re different
36+
37+
The strength of our community comes from its diversity, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
38+
39+
This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter.
40+
41+
## Diversity Statement
42+
43+
We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong.
44+
45+
Although this list cannot be exhaustive, we explicitly honor diversity in age, gender, gender identity or expression, culture, ethnicity, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
46+
47+
## Reporting Issues
48+
49+
If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via `opensource@moduscreate.com`. All reports will be handled with discretion. In your report please include:
50+
51+
* Your contact information.
52+
* Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link.
53+
* Any additional information that may be helpful.
54+
55+
After filing a report, a representative will contact you personally. If the person who is harassing you is part of the response team, they will recuse themselves from handling your incident. A representative will then review the incident, follow up with any additional questions, and make a decision as to how to respond. We will respect confidentiality requests for the purpose of protecting victims of abuse.
56+
57+
Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the representative may take any action they deem appropriate, up to and including a permanent ban from our community without warning.
58+
59+
This Code Of Conduct follows the [template](http://todogroup.org/opencodeofconduct/) established by the [TODO Group](http://todogroup.org/).

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing to Project
2+
3+
### Code of Conduct
4+
5+
Modus has adopted a [Code of Conduct](./CODE_OF_CONDUCT.md) that we expect project participants to adhere to.
6+
7+
### Submitting a Pull Request
8+
9+
If you are a first time contributor, you can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
10+
11+
### License
12+
13+
By contributing, you agree that your contributions will belicensed under it's [license](./LICENSE)

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2011-present, Modus Create, Inc.
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 all
13+
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 THE
21+
SOFTWARE.

README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
[![Logo of the project](./images/modus.logo.svg)](https://moduscreate.com)
2+
3+
# Name of the project
4+
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
6+
[![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/your/your-project/blob/master/LICENSE)
7+
8+
A brief description of your project, what it is used for.
9+
10+
## Installing / Getting started
11+
12+
A quick introduction of the minimal setup you need to get a hello world up &
13+
running.
14+
15+
```shell
16+
commands here
17+
```
18+
19+
Here you should say what actually happens when you execute the code above.
20+
21+
## Developing
22+
23+
### Built With
24+
25+
List main libraries, frameworks used including versions (React, Angular etc...)
26+
27+
### Prerequisites
28+
29+
What is needed to set up the dev environment. For instance, global dependencies or any other tools. Include download links.
30+
31+
### Setting up Dev
32+
33+
Here's a brief intro about what a developer must do in order to start developing
34+
the project further:
35+
36+
```shell
37+
git clone https://github.com/your/your-project.git
38+
cd your-project/
39+
packagemanager install
40+
```
41+
42+
And state what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here.
43+
44+
### Building
45+
46+
If your project needs some additional steps for the developer to build the
47+
project after some code changes, state them here. for example:
48+
49+
```shell
50+
./configure
51+
make
52+
make install
53+
```
54+
55+
Here again you should state what actually happens when the code above gets executed.
56+
57+
### Deploying / Publishing
58+
59+
give instructions on how to build and release a new version
60+
In case there's some step you have to take that publishes this project to a
61+
server, this is the right time to state it.
62+
63+
```shell
64+
packagemanager deploy your-project -s server.com -u username -p password
65+
```
66+
67+
And again you'd need to tell what the previous code actually does.
68+
69+
## Configuration
70+
71+
Here you should write what are all of the configurations a user can enter when
72+
using the project.
73+
74+
## Tests
75+
76+
Describe and show how to run the tests with code examples.
77+
Explain what these tests test and why.
78+
79+
```shell
80+
Give an example
81+
```
82+
83+
## Style guide
84+
85+
Explain your code style and show how to check it.
86+
87+
## Api Reference
88+
89+
If the api is external, link to api documentation. If not describe your api including authentication methods as well as explaining all the endpoints with their required parameters.
90+
91+
## Modus Create
92+
93+
[Modus Create](https://moduscreate.com) is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.
94+
95+
[![Modus Create](./images/modus.logo.svg)](https://moduscreate.com)
96+
97+
## Licensing
98+
99+
State what the license is and how to find the text version of the license.
100+
101+
e.g. This project is [MIT licensed](./LICENSE).

images/modus.logo.svg

Lines changed: 1 addition & 0 deletions
Loading

package-lock.json

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "ion-router-vue",
3+
"version": "1.0.0",
4+
"description": "Ion Router Vue",
5+
"homepage": "https://moduscreate.com",
6+
"author": "Modus Create <contact@moduscreate.com> (http://moduscreate.com)",
7+
"repository": "github:ModusCreateOrg/ion-router-vue",
8+
"main": "index.js",
9+
"license": "MIT",
10+
"engines": {
11+
"node": ">=8.9.10"
12+
},
13+
"dependencies": {
14+
"node": "10.0.0"
15+
},
16+
"scripts": {
17+
"start": "webpack-dev-server",
18+
"build": "webpack",
19+
"test": "echo \"Error: no test specified\" && exit 1"
20+
},
21+
"devDependencies": {
22+
"vue": "^2.5.16",
23+
"vue-router": "^3.0.1"
24+
}
25+
}

0 commit comments

Comments
 (0)