Skip to content

Commit 3af2170

Browse files
frankpaganfrankpagan
committed
feat: Initial Release
1 parent a2a69ac commit 3af2170

16 files changed

+373
-80
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-calculations.min.js'

‎.gitignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
# ignore app.js
2-
app.js
3-
package-lock.json
2+
node_modules

‎CONTRIBUTING.md‎

Lines changed: 24 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to CoCreate-attributes
1+
# Contributing to CoCreate-calculations
22

33
This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-calculations/graphs/contributors).
44
You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-calculations/pulls),
@@ -8,28 +8,27 @@ In the examples below, substitute your Github username for `contributor` in URLs
88

99
## Fork the Project
1010

11-
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-attributes) and check out your copy.
11+
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-calculations) and check out your copy.
1212

1313
```
14-
git clone https://github.com/contributor/CoCreate-attributes.git
15-
cd CoCreate-attributes
16-
git remote add upstream https://github.com/CoCreate-app/CoCreate-attributes.git
14+
git calculations https://github.com/contributor/CoCreate-calculations.git
15+
cd CoCreate-calculations
16+
git remote add upstream https://github.com/CoCreate-app/CoCreate-calculations.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-calculations/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: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
module.exports = {
2+
socket: {
3+
config: {
4+
apiKey: "c2b08663-06e3-440c-ef6f-13978b42883a",
5+
securityKey: "f26baf68-e3a9-45fc-effe-502e47116265",
6+
organization_Id: "5de0387b12e200ea63204d6c"
7+
},
8+
host: "server.cocreate.app:8088"
9+
},
10+
11+
sources: [{
12+
path: "./docs/index.html",
13+
collection: "website-pages",
14+
document_id: "",
15+
name: "html",
16+
},
17+
],
18+
19+
crud: [{
20+
collection: "routes",
21+
document_id: "",
22+
data:{collection: "website-pages",
23+
document_id: "",
24+
domains: ["general.cocreate.app"],
25+
route: "/docs/calculations",
26+
}
27+
}
28+
],
29+
30+
extract: {
31+
directory: "./src/",
32+
extensions: [
33+
"js",
34+
"css",
35+
"html"
36+
],
37+
ignores: [
38+
"node_modules",
39+
"vendor",
40+
"bower_components",
41+
"archive"
42+
],
43+
}
44+
}

‎README.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
# CoCreate Calculations
2-
A pure javascript calculation component. Using data-attributes and id of elements fetch values calculate and display result in any html element.
1+
# CoCreate-calculations
2+
A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable.
3+
4+
![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-calculations/dist/CoCreate-calculations.min.js?label=minified%20size&style=for-the-badge)
5+
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-calculations?style=for-the-badge)
6+
![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-calculations?style=for-the-badge)
7+
![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-calculations/help%20wanted?style=for-the-badge)
38

49
![CoCreate](https://cdn.cocreate.app/logo.png)
510

6-
[CoCreate Docs](https://cocreate.app/documentation/CoCreate-calculations)
11+
[CoCreate Docs](https://cocreate.app/docs/calculations)
712

813

914
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.
@@ -29,6 +34,7 @@ All updates to this library are documented in our [CHANGELOG](https://github.com
2934

3035
If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-calculations/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-calculations/pulls). We would love to hear your feedback.
3136

37+
3238
<a name="about"></a>
3339
# About
3440

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

4652
# License
4753
[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-calculations/blob/master/LICENSE)
54+

‎src/CoCreate-calculations.html‎ renamed to ‎demo/CoCreate-calculations.html‎

File renamed without changes.

‎dist/CoCreate-calculations.js‎

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

‎dist/CoCreate-calculations.min.js‎

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)