Skip to content

Commit 826f3f5

Browse files
committed
clean tree
1 parent beafef6 commit 826f3f5

File tree

13 files changed

+287
-61
lines changed

13 files changed

+287
-61
lines changed

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: CoCreate-app

.github/workflows/automation.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
create:
11+
branches:
12+
- master
13+
14+
jobs:
15+
updateKeyword:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v2
20+
21+
- name: Jaid/action-sync-node-meta
22+
uses: jaid/[email protected]
23+
with:
24+
direction: overwrite-github # default is overwrite-file
25+
githubToken: ${{ secrets.GITHUB }}
26+
27+
ci:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v2
32+
33+
- name: Semantic Release
34+
uses: cycjimmy/semantic-release-action@v2
35+
with:
36+
# You can specify specifying version range for the extra plugins if you prefer.
37+
extra_plugins: |
38+
@semantic-release/changelog
39+
@semantic-release/npm
40+
@semantic-release/git
41+
@semantic-release/github
42+
env:
43+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
44+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} # Auto Changog generator
45+
46+
docs:
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Checkout
50+
uses: actions/checkout@v2
51+
52+
- name: update documentation
53+
uses: CoCreate-app/CoCreate-docs@master
54+
55+
56+
cdn:
57+
runs-on: ubuntu-latest
58+
steps:
59+
- name: Checkout
60+
uses: actions/checkout@v2
61+
62+
- name: upload cdn
63+
uses: CoCreate-app/CoCreate-s3@master
64+
with:
65+
aws-key-id: ${{ secrets.AWSACCESSKEYID }}
66+
aws-access-key: ${{ secrets.AWSSECERTACCESSKEY }}
67+
source: './dist/CoCreate-dashboard.min.js'

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# ignore
2+
node_modules

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# CHANGELOG
2-
1+

CONTRIBUTING.md

Lines changed: 20 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,24 @@ In the examples below, substitute your Github username for `contributor` in URLs
1111
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-dashboard) and check out your copy.
1212

1313
```
14-
git clone https://github.com/contributor/CoCreate-dashboard.git
14+
git dashboard https://github.com/contributor/CoCreate-dashboard.git
1515
cd CoCreate-dashboard
1616
git remote add upstream https://github.com/CoCreate-app/CoCreate-dashboard.git
1717
```
1818

1919
## Create a Topic Branch
2020

21-
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
21+
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix on dev branch.
2222

2323
```
24-
git checkout master
25-
git pull upstream master
24+
git checkout dev
25+
git pull upstream dev
2626
git checkout -b my-feature-branch
2727
```
2828

2929
## Write Tests
3030

3131
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
32-
Add to [spec](spec).
3332

3433
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
3534

@@ -41,11 +40,6 @@ Implement your feature or bug fix.
4140

4241
Document any external behavior in the [README](README.md).
4342

44-
## Update Changelog
45-
46-
Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
47-
Make it look like every other line, including your name and link to your Github account.
48-
4943
## Commit Changes
5044

5145
Make sure git knows your name and email address:
@@ -55,13 +49,24 @@ git config --global user.name "Your Name"
5549
git config --global user.email "[email protected]"
5650
```
5751

58-
Writing good commit logs is important. A commit log should describe what changed and why.
52+
We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog
53+
and to release. Write meaningful commits according to
54+
[Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important.
5955

6056
```
6157
git add ...
62-
git commit
58+
git commit -am "commit-type(optional topic): a meaningful message"
6359
```
6460

61+
Here is an example of the release type that should be done based on a [semantic-release](https://github.com/semantic-release/semantic-release):
62+
63+
| Commit message | Release type |
64+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
65+
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
66+
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
67+
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
68+
69+
6570
## Push
6671

6772
```
@@ -75,36 +80,17 @@ Click the 'Pull Request' button and fill out the form. Pull requests are usually
7580

7681
## Rebase
7782

78-
If you've been working on a change for a while, rebase with upstream/master.
83+
If you've been working on a change for a while, rebase with upstream/dev.
7984

8085
```
8186
git fetch upstream
82-
git rebase upstream/master
87+
git rebase upstream/dev
8388
git push origin my-feature-branch -f
8489
```
8590

86-
## Update CHANGELOG Again
87-
88-
Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
89-
90-
```
91-
* [#123](https://github.com/CoCreate-app/CoCreate-dashboard/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
92-
```
93-
94-
Amend your previous commit and force push the changes.
95-
96-
```
97-
git commit --amend
98-
git push origin my-feature-branch -f
99-
```
100-
101-
## Check on Your Pull Request
102-
103-
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
104-
10591
## Be Patient
10692

107-
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
93+
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there!
10894

10995
## Thank You
11096

CoCreate.config.js

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
module.exports = {
2+
config: {
3+
apiKey: "c2b08663-06e3-440c-ef6f-13978b42883a",
4+
securityKey: "f26baf68-e3a9-45fc-effe-502e47116265",
5+
organization_Id: "5de0387b12e200ea63204d6c",
6+
host: "server.cocreate.app:8088"
7+
},
8+
9+
sources: [{
10+
path: "./docs/index.html",
11+
collection: "files",
12+
document_id: "",
13+
key: "html",
14+
data:{
15+
name: "dashboard Doc",
16+
}
17+
},
18+
],
19+
20+
crud: [{
21+
collection: "routes",
22+
document_id: "",
23+
data:{
24+
collection: "files",
25+
document_id: "",
26+
name: "html",
27+
domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
28+
route: "/docs/dashboard",
29+
}
30+
}
31+
],
32+
33+
extract: {
34+
directory: "./src/",
35+
extensions: [
36+
"js",
37+
"css",
38+
"html"
39+
],
40+
ignores: [
41+
"node_modules",
42+
"vendor",
43+
"bower_components",
44+
"archive"
45+
],
46+
}
47+
}

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-boilerplate/dist/CoCreate-boilerplate.min.js?label=minified%20size)
2-
![GitHub package.json version](https://img.shields.io/github/package-json/v/CoCreate-app/CoCreate-boilerplate)
3-
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-boilerplate)
4-
![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-boilerplate/help%20wanted)
5-
61
# CoCreate-dashboard
7-
A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable.
2+
A simple dashboard component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/dashboard)
83

9-
![CoCreate](https://cdn.cocreate.app/logo.png)
4+
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-dashboard/dist/CoCreate-dashboard.min.js?label=minified%20size&style=for-the-badge)
5+
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-dashboard?style=for-the-badge)
6+
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-dashboard?style=for-the-badge)
7+
![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-dashboard/help%20wanted?style=for-the-badge)
108

11-
[CoCreate Docs](https://cocreate.app/documentation/CoCreate-dashboard)
9+
![CoCreate](https://cdn.cocreate.app/logo.png)
1210

11+
[CoCreate Docs](https://cocreate.app/docs/dashboard)
1312

1413
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/Realtime_Admin_CRM_and_CMS/issues) and [pull requests](https://github.com/CoCreate-app/Realtime_Admin_CRM_and_CMS/pulls) or merely upvote or comment on existing issues or pull requests.
1514

@@ -51,3 +50,4 @@ We encourage contribution to our libraries (you might even score some nifty swag
5150

5251
# License
5352
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-dashboard/blob/master/LICENSE)
53+

documentation/index.html renamed to docs/index.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<title>CoCreate-boilerplate Documentation | CoCreateJS </title>
7+
<title>CoCreate-dashboard Documentation | CoCreateJS </title>
88
<link rel="icon" type="image/png" sizes="32x32" href="https://cocreate.app/images/favicon.ico">
99
<meta name="description" content="A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable." />
1010
<meta name="keywords" content="helper classes, utility classes, css framework, css library, inline style classes" />
@@ -28,49 +28,49 @@
2828
</head>
2929

3030
<body>
31-
<div data-collection="" data-document_id="" name="" id="cocreate-boilerplate" class="padding:15px">
31+
<div data-collection="" data-document_id="" name="" id="cocreate-dashboard" class="padding:15px">
3232
<div class="display:flex flex-wrap:wrap justify-content:space-between">
3333
<div class="display:flex align-items:center">
34-
<h2>CoCreate-boilerplate</h2>
34+
<h2>CoCreate-dashboard</h2>
3535
</div>
3636
<div class="display:flex align-items:center font-size:20px social_share" data-height="600" data-width="500" data-media="https://via.placeholder.com/300/09f/fff.png">
37-
<a href="https://github.com/CoCreate-app/CoCreate-boilerplate" target="_blank" class="margin-right:15px"><i class="fab fa-github"></i></a>
37+
<a href="https://github.com/CoCreate-app/CoCreate-dashboard" target="_blank" class="margin-right:15px"><i class="fab fa-github"></i></a>
3838
<a class="margin-right:15px share" data-network='twitter' title="Share on twitter"><i class="fab fa-twitter"></i></a>
3939
<a class="margin-right:15px share" data-network='facebook' title="Share on Facebook"><i class="fab fa-facebook"></i></a>
4040
<a class="margin-right:15px share" data-network='instagram' title="Share on instagram"><i class="fab fa-instagram"></i></a>
4141
<a class="margin-right:15px share" data-network='share' title="Share on share"><i class="fas fa-share-alt"></i></a>
4242
</div>
4343
</div>
4444
<p class="max-width:500px margin:20px_0px">A simple HTML5, CSS and pure javascript component. Easy configuration using data-attributes and highly styleable.</p>
45-
<div id="boilerplate-section" class="display:flex flex-wrap:wrap">
45+
<div id="dashboard-section" class="display:flex flex-wrap:wrap">
4646
<div class="flex-grow:1 min-width:300px width:50% padding:0px_10px margin:20px_0px">
4747

4848
<h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">Install</h2>
49-
<pre><code class="language-javascript">npm install cocreate-boilerplate</code></pre>
49+
<pre><code class="language-javascript">npm install cocreate-dashboard</code></pre>
5050
<p class="padding:10px_0px">Or you can use cdn link:</p>
51-
<pre><code class="language-javascript">https://cdn.cocreate.app/CoCreate-boilerplate.min.js</code></pre>
51+
<pre><code class="language-javascript">https://cdn.cocreate.app/CoCreate-dashboard.min.js</code></pre>
5252

5353
<h2 class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Usage</h2>
5454
<div class="">
55-
<p class="padding:10px_0px">This is boilerplate reference</p>
55+
<p class="padding:10px_0px">This is dashboard reference</p>
5656

5757
<div class="flex-grow:1 min-width:300px width:100%">
5858
<pre>
5959
<code>&lt;div&gt;&lt;/div&gt;</code>
6060
</pre>
6161
</div>
62-
<p class="padding:10px_0px">This is boilerplate reference</p>
63-
<p class="padding:10px_0px">This is boilerplate reference</p>
62+
<p class="padding:10px_0px">This is dashboard reference</p>
63+
<p class="padding:10px_0px">This is dashboard reference</p>
6464
</div>
6565
<h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">Attributes</h2>
6666
<ul class="list-style-type:none ">
6767
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
68-
<h4><span>data-boilerplate</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
69-
<p>boilerplate-attribute</p>
68+
<h4><span>data-dashboard</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
69+
<p>dashboard-attribute</p>
7070
</li>
7171
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
72-
<h4><span>data-boilerplate</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
73-
<p>boilerplate-attribute</p>
72+
<h4><span>data-dashboard</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
73+
<p>dashboard-attribute</p>
7474
</li>
7575
</ul>
7676
</div>

package.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"name": "@cocreate/dashboard",
3+
"version": "1.0.0",
4+
"description": "A simple dashboard component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API.",
5+
"keywords": ["dashboard","cocreate","low-code-framework","no-code-framework","cocreatejs","cocreatejs-component","cocreate-framework","no-code","low-code","collaborative-framework","realtime","realtime-framework","collaboration","shared-editing","html5-framework","javascript-framework"],
6+
"publishConfig": {
7+
"access": "public"
8+
},
9+
"scripts": {
10+
"start": "npx webpack --config webpack.config.js --watch",
11+
"build": "NODE_ENV=production npx webpack --config webpack.config.js",
12+
"docs": "node ./node_modules/@cocreate/docs/src/index.js"
13+
},
14+
"repository": {
15+
"type": "git",
16+
"url": "git+https://github.com/CoCreate-app/CoCreate-dashboard.git"
17+
},
18+
"author": "CoCreate LLC",
19+
"license": "MIT",
20+
"bugs": {
21+
"url": "https://github.com/CoCreate-app/CoCreate-dashboard/issues"
22+
},
23+
"homepage": "https://cocreate.app/docs/dashboard",
24+
"devDependencies": {
25+
"@babel/core": "^7.12.10",
26+
"@babel/preset-env": "^7.12.11",
27+
"babel-loader": "^8.2.2",
28+
"clean-webpack-plugin": "^3.0.0",
29+
"html-webpack-plugin": "^4.5.0",
30+
"uglifyjs-webpack-plugin": "^2.2.0",
31+
"webpack": "^5.14.0",
32+
"webpack-cli": "^4.3.1",
33+
"webpack-log": "^3.0.1"
34+
},
35+
36+
"dependencies": {
37+
"@cocreate/docs": "^1.0.3"
38+
}
39+
}

0 commit comments

Comments
 (0)