Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nv-marcel-kaleta committed Feb 18, 2020
0 parents commit 8c2ef5b
Show file tree
Hide file tree
Showing 153 changed files with 23,604 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"rules": {
"body-leading-blank": [1, "always"],
"footer-leading-blank": [1, "always"],
"header-max-length": [2, "always", 100],
"scope-case": [2, "always", "lower-case"],
"subject-case": [
2,
"never",
["sentence-case", "start-case", "pascal-case", "upper-case"]
],
"subject-empty": [2, "never"],
"subject-full-stop": [2, "never", "."],
"type-case": [2, "always", "lower-case"],
"type-empty": [2, "never"],
"type-enum": [
2,
"always",
[
"build",
"chore",
"ci",
"docs",
"feat",
"fix",
"perf",
"refactor",
"revert",
"style",
"test"
]
]
}
}
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Editor configuration, see http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false
33 changes: 33 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.

# compiled output
/dist
/tmp
/out-tsc

# dependencies
/node_modules

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
.vscode/*

# misc
/.sass-cache
/connect.lock
/coverage
/libpeerconnection.log
npm-debug.log
yarn-error.log
testem.log
/typings

# System Files
.DS_Store
Thumbs.db
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Add files here to ignore them from prettier formatting

/dist
/coverage
10 changes: 10 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"printWidth": 120,
"tabWidth": 2,
"useTabs": false,
"semi": true,
"singleQuote": true,
"trailingComma": "none",
"bracketSpacing": true,
"parser": "typescript"
}
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

- Dynamically changing Brand Component
- Editable JSON-Editor :P
- Readonly for custom Components
- Form Component

## 0.1.0 - 2020-02-18
### Added

- Brand Component
- Breadcrumb Component
- Breakpoint Component
- Checkbox Component
- Footer Component
- Insertion Component
- JSON-Editor Component
- Navbar Component
- Radio Component
- Readonly Directive
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to contribute

Every Component should have:
- Tests
- TSDoc
- Page with Documentation
- Correct display attribute on the :host
- Add everything that needs to be exported to the index.ts
- Every Component has its own Module
- Add new Components to JabalModule
- Prefix Components with jbl-
- Simple Module Names (no prefix)
- Add as little SCSS as possible, Component HTML should be able to be copied without a problem

Generate a component with:
```
ng g module footer --project="jabal"
```
```
ng g component footer --project="jabal" --changeDetection=OnPush --export="true" --module="footer/footer.module.ts"
```

Commit with:
```
npm run commit
```
This helps you creating a conventional commit.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Marcel Kaleta

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.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Jabal

Jabal is a collection of components that will aid you with developing your
app using Bootstrap.
Libraries like ngx-bootstrap have a lot of components, but how you include them
inside your app is something you have to think about. Jabal is a opinionated
library that gives you an idea on how to build your app and simultaneously
implements missing components from the Bootstrap ecosystem.

Whilst we are providing you with components which have a way of doing things,
they are built in a way, that gives you the possibility of writing your own
component based on ours. We want you to not have to restart from scratch
every time a component isn't the way it should be for you.

# Getting started

Install Jabal:
```
npm i ngx-jabal
```

Import some Module:
```
import { BreadcrumbModule } from 'ngx-jabal/breadcrumb';
@NgModule({
...
imports: [BreadcrumbModule,...]
...
})
```

If you do not have it included already, you will also need to get bootstrap.
We recommend using following method:
```
npm i bootstrap
```

Add it to your angular.json:
```
...
"styles": [
"node_modules/bootstrap/dist/css/bootstrap.min.css",
"src/styles.scss"
]
...
```

# [Documentation](https://jabal.dev/)

Documentation is under construction...
Loading

0 comments on commit 8c2ef5b

Please sign in to comment.