Skip to content

Commit

Permalink
Initial committ
Browse files Browse the repository at this point in the history
  • Loading branch information
jonerickson committed Oct 3, 2023
0 parents commit c48dbe2
Show file tree
Hide file tree
Showing 17 changed files with 4,757 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# PERSCOM Zapier Code of Conduct

## Our Pledge

We, as contributors and maintainers, pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- **Respect**: Being respectful of differing viewpoints and experiences.
- **Open-Mindedness**: Being open to constructive criticism and new ideas.
- **Collaboration**: Working together effectively and harmoniously towards common goals.
- **Inclusivity**: Welcoming individuals of all backgrounds and identities.

Examples of unacceptable behavior include:

- **Harassment**: Any form of harassment or discrimination will not be tolerated.
- **Trolling and Flaming**: Deliberate intimidation or antagonistic behavior.
- **Personal Attacks**: Public or private attacks on an individual's character.
- **Unwelcome Advances**: Unsolicited attention or contact.

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email address]. All complaints will be reviewed and investigated, and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

## Questions or Concerns?

If you have any questions or concerns about this Code of Conduct or its enforcement, please contact the project team at [email address].
82 changes: 82 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Contributing to the PERSCOM Zapier

Thank you for your interest in contributing to PERSCOM Zapier! We welcome contributions from the community to help improve and grow this project. Please take a moment to read through the following guidelines to ensure a smooth contribution process.

## Table of Contents
1. [Getting Started](#getting-started)
- [Fork the Repository](#fork-the-repository)
- [Clone Your Fork](#clone-your-fork)
- [Set Up the Development Environment](#set-up-the-development-environment)
2. [Making Changes](#making-changes)
- [Branching](#branching)
- [Coding Guidelines](#coding-guidelines)
- [Testing](#testing)
3. [Submitting Changes](#submitting-changes)
- [Creating a Pull Request](#creating-a-pull-request)
- [Pull Request Checklist](#pull-request-checklist)
4. [Community and Communication](#community-and-communication)
5. [License](#license)

## Getting Started

### Fork the Repository

To contribute to this project, you'll need to fork the repository to your own GitHub account. Click the "Fork" button on the top-right corner of the [repository page](https://github.com/DeschutesDesignGroupLLC/perscom-zapier).

### Clone Your Fork

After forking, clone your forked repository to your local machine:

```shell
git clone https://github.com/DeschutesDesignGroupLLC/perscom-zapier.git
```

### Set Up the Development Environment

Ensure you have PHP installed on your machine along with any necessary dependencies. Refer to the project's documentation for specific setup instructions.

## Making Changes

### Branching

Create a new branch for your work, using a descriptive name:

```shell
git checkout -b feature/your-feature-name
```

### Coding Guidelines

Please follow the coding style and guidelines defined in the project's documentation. Consistency makes it easier to review and merge your changes.

### Testing

Before submitting your changes, make sure to run any relevant tests and ensure that your code does not introduce new issues.

## Submitting Changes

### Creating a Pull Request

Once your changes are ready, push your branch to your forked repository on GitHub:

```shell
git push origin feature/your-feature-name
```

Then, navigate to the [original repository](https://github.com/DeschutesDesignGroupLLC/perscom-zapier) and create a pull request. Provide a clear title and description of your changes.

### Pull Request Checklist

Before submitting your pull request, please make sure you have done the following:
- [ ] Followed the coding guidelines.
- [ ] Included relevant tests if applicable.
- [ ] Written clear and concise commit messages.
- [ ] Checked that your code builds and runs without errors.

## Community and Communication

Join our [community chat](https://community.deschutesdesigngroup.com) to stay connected with other contributors and maintainers. We appreciate your feedback and involvement!

## License

By contributing to this project, you agree that your contributions will be licensed under the [project's license](https://github.com/DeschutesDesignGroupLLC/perscom-zapier).
57 changes: 57 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<p align="center"><img src="../art/header.png" alt="Logo"></p>

<div align="center">

# The Official PERSCOM Zapier Integration

The PERSCOM Zapier Integration delivers a top-tier automated solution for overseeing your personnel data. It achieves this by seamlessly merging your PERSCOM data with Zapier's extensive collection of 6,000+ other applications.

[![Test Suite](https://github.com/DeschutesDesignGroupLLC/perscom-zapier/actions/workflows/tests.yml/badge.svg)](https://github.com/DeschutesDesignGroupLLC/perscom-zapier/actions/workflows/tests.yml)

[Documentation](https://docs.perscom.io)

</div>

## Introduction

Zapier is a versatile platform that empowers you to create and oversee automated workflows, seamlessly connecting with a vast array of 6,000+ other applications. With the incorporation of the PERSCOM Zapier Integration, you gain the capacity to effortlessly handle your personnel data, opening up boundless possibilities for workflow customization.

## Getting Started

To begin, follow these steps:

1. Download the Zapier Platform SDK and log in:

```bash
# Install the CLI globally
npm install -g zapier-platform-cli

# Set up authentication to Zapier's platform with a deploy key
zapier login
```

2. Install the necessary dependencies:

```bash
npm install
```

3. Execute the unit tests:

```bash
zapier test
```

4. Finally, upload the app to your private Zapier app repository:

```bash
zapier push
```

## Documentation

Visit our documentation [here](https://docs.perscom.io) to get started.

## Contributing

Please see [here](../.github/CONTRIBUTING.md) for more details about contributing.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: weekly
open-pull-requests-limit: 5
target-branch: "develop"
ignore:
- dependency-name: "*"
update-types: ["version-update:semver-patch"]
26 changes: 26 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: Added
labels:
- 'Type: Enhancement'
- title: Changed
labels:
- 'Type: Maintenance'
- title: Deprecated
labels:
- 'Type: Deprecation'
- title: Removed
labels:
- 'Type: Removed'
- title: Fixed
labels:
- 'Type: Bug'
- title: Security
labels:
- 'Type: Vulnerability'
- title: Other
labels:
- '*'
35 changes: 35 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Test Suite

on:
push:
branches:
- 'master'
pull_request:
branches:
- '*'

jobs:
tests:
name: Run Test Suite
runs-on: ubuntu-latest
steps:
- name: Checkout Source
uses: actions/checkout@v3

- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '18'
cache: 'npm'

- name: Install Javascript Dependencies
run: npm ci

- name: Install Zapier Platform SDK
run: npm install -g zapier-platform-cli

- name: Validate App
run: zapier validate

- name: Run Tests
run: zapier test
63 changes: 63 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.idea

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# environment variables file
.env
.environment

# next.js build output
.next
20 changes: 20 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"arrowParens": "always",
"bracketSpacing": true,
"embeddedLanguageFormatting": "auto",
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"jsxBracketSameLine": false,
"jsxSingleQuote": true,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": false,
"singleQuote": true,
"trailingComma": "none",
"useTabs": false,
"vueIndentScriptAndStyle": false,
"printWidth": 140,
"tabWidth": 2,
"rangeStart": 0
}
4 changes: 4 additions & 0 deletions .zapierapprc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"id": 192496,
"key": "App192496"
}
Binary file added art/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c48dbe2

Please sign in to comment.