Skip to content

Commit d5897f8

Browse files
author
Roman
committed
Merge branch 'develop'
2 parents 9755590 + dff7bc1 commit d5897f8

File tree

143 files changed

+164525
-101658
lines changed

Some content is hidden

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

143 files changed

+164525
-101658
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ src/**.js.map
2121
!demo/public/cui-demo.css
2222
!demo/public/css
2323
coverage/*
24+
*.map
25+
_obsolete.scss

‎README.md‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,25 @@ npm install --save-dev git+https://github.com/programmfabrik/coffeescript-ui.git
1818

1919
### Versions
2020

21-
- **cui.min.js**: Minified (default version)
21+
- **cui.min.js**: Minified (default version)
2222
- **cui.js**: No minified (recommended for development)
2323

24-
### Usage
24+
### Usage
2525

2626
With *require*
2727

2828
```
2929
require('coffeescript-ui') (uses default version)
3030
require('coffeescript-ui/public/cui.js')
3131
```
32-
32+
3333
With *\<script\>* tag
34-
35-
```
34+
35+
```
3636
<script src="node_modules/coffeescript-ui/public/cui.min.js" type="text/javascript" charset="utf-8"></script>
3737
<script src="node_modules/coffeescript-ui/public/cui.js" type="text/javascript" charset="utf-8"></script>
3838
```
39-
39+
4040
#### Use cui.css (Optional, recommended)
4141

4242
With CUI.CSSLoader
@@ -47,11 +47,11 @@ CUI.ready ->
4747
```
4848

4949
With require
50-
51-
```
50+
51+
```
5252
require('coffeescript-ui/public/cui.css')
5353
```
54-
54+
5555
With *\<link\>* tag
5656

5757
```
@@ -69,24 +69,30 @@ plugins: [
6969
'CUI': "coffeescript-ui" // or "coffeescript-ui/public/cui.js" (for development)
7070
})
7171
...
72-
]
72+
]
7373
```
74-
74+
7575
## Build
7676

7777
The first step is to download all dependencies with *npm install*
7878

79-
After that, it's necessary to run one of the following build commands
79+
After that, it's necessary to run one of the following build commands
8080

81-
- **npm run build**: Builds the default version
82-
- **npm run build:minify**: Builds the minified version
83-
- **npm run build:all**: Builds one of each version
81+
- **npm run build**: Builds the default version for development
82+
- **npm run build:production**: Builds the default version for production (minified, no sourcemaps)
8483
- **npm run build:watch**: Builds the default version and watch for changes
84+
- **npm run build:all**: Builds both minified JS and CSS as well as non-minified/development versions with no sourcemaps. "cui.min.js" or "cui.js" are used in the final build (see makefile), "cui.js" is used in the DEMO.)
85+
86+
# Deprecated:
87+
- **npm run build:min**: Builds the minified version, run **npm run build:production** instead
8588

8689
You will find the bundled file inside **public** folder.
8790

8891
It's not necessary to build the project before use it, because **public** directory has always the last version.
8992

93+
# Icons:
94+
- **gulp svgstore**: Build the icons.svg from all icons included in /scss/icons
95+
9096
## Test
9197

9298
To run the tests:
@@ -99,4 +105,4 @@ https://programmfabrik.github.io/coffeescript-ui/demo/index.html
99105

100106
## Live Tutorial
101107

102-
https://programmfabrik.github.io/coffeescript-ui/tutorial/index.html
108+
https://programmfabrik.github.io/coffeescript-ui/tutorial/index.html

‎demo/README.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,21 @@ Then you can run different targets, with *npm run **%TARGET%***
1212

1313
**%TARGET%** should be one of the following:
1414

15-
- **build**: Builds the demo with CSS
15+
- **build**: Builds the demo with CSS for development
16+
- **build:production**: Builds the demo with CSS for production (minimizing code, no sourcemaps)
1617
- **build:watch**: Builds the demo with CSS and watch for changes
1718

18-
As output, there will be two files: *cui-demo.js* and *index.html*, located in **public** directory. Open **public/index.html** too see the demo.
19+
As output, there will be the following files under **/public/**
20+
- *cui-demo.js*
21+
- *cui-demo.css*
1922

20-
## Run
23+
The CSS theme files will be in **public/css**.
2124

22-
- npm start
25+
Open **index.html** too see the demo.
26+
27+
## Run webpack-dev-server
28+
29+
- npm run start
2330
- Open http://localhost:8080/
2431

2532
## Using **coffeescript-ui** locally

‎demo/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</style>
3030

3131
<link rel="stylesheet" type="text/css" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
32-
<link rel="stylesheet" charset="utf-8" href="cui-demo.css" >
32+
<link rel="stylesheet" charset="utf-8" href="public/cui-demo.css" >
3333
</head>
3434
<body class="cui-body">
3535
<div id="cui-demo-splash">

0 commit comments

Comments
 (0)