Skip to content

Commit

Permalink
feat: Initial Release
Browse files Browse the repository at this point in the history
  • Loading branch information
frankpagan committed Jun 27, 2022
0 parents commit bd4e59c
Show file tree
Hide file tree
Showing 17 changed files with 1,274 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
@@ -0,0 +1,3 @@
# These are supported funding model platforms

github: CoCreate-app
83 changes: 83 additions & 0 deletions .github/workflows/automated.yml
@@ -0,0 +1,83 @@
name: Automated
"on":
push:
branches:
- master
jobs:
about:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Jaid/action-sync-node-meta
uses: jaid/action-sync-node-meta@v1.4.0
with:
direction: overwrite-github
githubToken: "${{ secrets.GITHUB }}"
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v2
id: semantic
with:
extra_plugins: |
@semantic-release/changelog
@semantic-release/git
@semantic-release/github
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"
outputs:
new_release_published: "${{ steps.semantic.outputs.new_release_published }}"
new_release_version: "${{ steps.semantic.outputs.new_release_version }}"
cdn:
runs-on: ubuntu-latest
needs: release
if: needs.release.outputs.new_release_published == 'true'
env:
VERSION: "${{ needs.release.outputs.new_release_version }}"
steps:
- name: Checkout
uses: actions/checkout@v2
- name: setup nodejs
uses: actions/setup-node@v2
with:
node-version: 14.15.4
- name: yarn install
run: >
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >
.npmrc
yarn install
- name: yarn build
run: yarn build
- name: upload bundle as version
uses: CoCreate-app/CoCreate-s3@master
with:
aws-key-id: "${{ secrets.AWSACCESSKEYID }}"
aws-access-key: "${{ secrets.AWSSECERTACCESSKEY }}"
bucket: testcrudbucket
source: ./dist
destination: "/position/${{env.VERSION}}"
acl: public-read
- name: upload bundle as latest
uses: CoCreate-app/CoCreate-s3@master
with:
aws-key-id: "${{ secrets.AWSACCESSKEYID }}"
aws-access-key: "${{ secrets.AWSSECERTACCESSKEY }}"
bucket: testcrudbucket
source: ./dist
destination: /position/latest
acl: public-read
invalidations: true
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2

- name: update documentation
uses: CoCreate-app/CoCreate-docs@master
44 changes: 44 additions & 0 deletions .github/workflows/manual.yml
@@ -0,0 +1,44 @@
name: Manual Workflow
on:
workflow_dispatch:
inputs:
invalidations:
description: |
If set to 'true', invalidates previous upload.
default: "true"
required: true

jobs:
cdn:
runs-on: ubuntu-latest
env:
DRY_RUN: ${{ github.event.inputs.dry_run }}
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"

steps:
- name: Checkout
uses: actions/checkout@v2
- name: setup nodejs
uses: actions/setup-node@v2
with:
node-version: 14.15.4
- name: yarn install
run: >
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >
.npmrc
yarn install
- name: yarn build
run: yarn build
- name: upload latest bundle
uses: CoCreate-app/CoCreate-s3@master
with:
aws-key-id: "${{ secrets.AWSACCESSKEYID }}"
aws-access-key: "${{ secrets.AWSSECERTACCESSKEY }}"
distributionId: "${{ secrets.DISTRIBUTION_ID }}"
bucket: testcrudbucket
source: ./dist
destination: /position/latest
acl: public-read
invalidations: ${{ github.event.inputs.invalidations }}
13 changes: 13 additions & 0 deletions .gitignore
@@ -0,0 +1,13 @@
# ignore
node_modules
dist
.npmrc
yarn.lock

logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
Empty file added CHANGELOG.md
Empty file.
97 changes: 97 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,97 @@
# Contributing to CoCreate-position

This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-position/graphs/contributors).
You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-position/pulls),
[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-position/issues).

In the examples below, substitute your Github username for `contributor` in URLs.

## Fork the Project

Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-position) and check out your copy.

```
git modal https://github.com/contributor/CoCreate-position.git
cd CoCreate-position
git remote add upstream https://github.com/CoCreate-app/CoCreate-position.git
```

## Create a Topic Branch

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

```
git checkout dev
git pull upstream dev
git checkout -b my-feature-branch
```

## Write Tests

Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.

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

## Write Code

Implement your feature or bug fix.

## Write Documentation

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

## Commit Changes

Make sure git knows your name and email address:

```
git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"
```

We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog
and to release. Write meaningful commits according to
[Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important.

```
git add ...
git commit -am "commit-type(optional topic): a meaningful message"
```

Here is an example of the release type that should be done based on a [semantic-release](https://github.com/semantic-release/semantic-release):

| Commit message | Release type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `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 |


## Push

```
git push origin my-feature-branch
```

## Make a Pull Request

Go to [https://github.com/CoCreate-app/CoCreate-position](https://github.com/CoCreate-app/CoCreate-position) and select your feature branch.
Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.

## Rebase

If you've been working on a change for a while, rebase with upstream/dev.

```
git fetch upstream
git rebase upstream/dev
git push origin my-feature-branch -f
```

## Be Patient

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!

## Thank You

Please do know that we really appreciate and value your time and work. We love you, really.
43 changes: 43 additions & 0 deletions CoCreate.config.js
@@ -0,0 +1,43 @@
module.exports = {
"config": {
"apiKey": "2061acef-0451-4545-f754-60cf8160",
"organization_id": "5ff747727005da1c272740ab",
"host": "general.cocreate.app"
},

"sources": [{
"entry": "./docs/index.html",
"collection": "files",
"document_id": "60206d5b3c260207bf49cab4",
"key": "src",
"data":{
"name": "index.html",
"path": "/docs/modal/index.html",
"domains": [
"*",
"general.cocreate.app"
],
"directory": "/docs/modal",
"content-type": "text/html",
"public": "true",
"website_id": "5ffbceb7f11d2d00103c4535"
}
}
],

"extract": {
"directory": "./src/",
"extensions": [
"js",
"css",
"html"
],
"ignores": [
"node_modules",
"vendor",
"bower_components",
"archive"
]
}
}

21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 CoCreate LLC

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.
85 changes: 85 additions & 0 deletions README.md
@@ -0,0 +1,85 @@
# CoCreate-position

A draggable, movable and resizable modal. customizable via attributes, great for popups, alerts, multitasking and displaying multiple views. Take it for a spin in our [playground!](https://cocreate.app/docs/modal)

![minified](https://img.badgesize.io/https://cdn.cocreate.app/modal/latest/CoCreate-position.min.js?style=flat-square&label=minified&color=orange)
![gzip](https://img.badgesize.io/https://cdn.cocreate.app/modal/latest/CoCreate-position.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
![brotli](https://img.badgesize.io/https://cdn.cocreate.app/modal/latest/CoCreate-position.min.js?compression=brotli&style=flat-square&label=brotli)
![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-position?style=flat-square)
![License](https://img.shields.io/github/license/CoCreate-app/CoCreate-position?style=flat-square)
![Hiring](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)

![CoCreate-position](https://cdn.cocreate.app/docs/CoCreate-position.gif)

## [Docs & Demo](https://cocreate.app/docs/modal)

For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/modal)

## CDN

```html
<script src="https://cdn.cocreate.app/modal/latest/CoCreate-position.min.js"></script>
```

```html
<script src="https://cdn.cocreate.app/modal/latest/CoCreate-position.min.css"></script>
```

## NPM

```shell
$ npm i @cocreate/modal
```

## yarn

```shell
$ yarn install @cocreate/modal
```

# Table of Contents

- [Table of Contents](#table-of-contents)
- [Announcements](#announcements)
- [Roadmap](#roadmap)
- [How to Contribute](#how-to-contribute)
- [About](#about)
- [License](#license)

<a name="announcements"></a>

# Announcements

All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-position/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-position/releases). You may also subscribe to email for releases and breaking changes.

<a name="roadmap"></a>

# Roadmap

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-position/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-position/pulls). We would love to hear your feedback.

<a name="about"></a>

# About

CoCreate-position is guided and supported by the CoCreate Developer Experience Team.

Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.

CoCreate-position is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.

<a name="contribute"></a>

# How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-position/blob/master/CONTRIBUTING.md) guide for details.

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/CoCreate-position/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-position/pulls) or merely upvote or comment on existing issues or pull requests.

We appreciate your continued support, thank you!


<a name="license"></a>
# License

[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-position/blob/master/LICENSE)

0 comments on commit bd4e59c

Please sign in to comment.