Skip to content

Commit

Permalink
Merge pull request #1 from hovancik/basic-features
Browse files Browse the repository at this point in the history
Adds initial functionality
  • Loading branch information
hovancik authored Jan 22, 2022
2 parents 156bc32 + f5b84fb commit 50e0f1a
Show file tree
Hide file tree
Showing 26 changed files with 4,353 additions and 658 deletions.
8 changes: 6 additions & 2 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
module.exports = {
root: true,
extends: ['eslint:recommended'],
extends: ['eslint:recommended', 'standard'],
plugins: ['svelte3'],
overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
rules: {
'no-multiple-empty-lines': [ 'error', { max: 1, maxBOF: 2, maxEOF: 0 } ]
},
parserOptions: {
sourceType: 'module',
ecmaVersion: 2020
},
env: {
browser: true,
es2017: true,
node: true
node: true,
mocha: true
}
};
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# These are supported funding model platforms

github: hovancik # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: hovancik
#open_collective: # Replace with a single Open Collective username
#ko_fi: # Replace with a single Ko-fi username
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
custom: https://www.paypal.me/janhovancik # Replace with a single custom sponsorship URL
132 changes: 132 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
**Filling this report is required and failure to do so will result in closing the issue.**
- type: checkboxes
id: version
attributes:
label: Version
description: We only support the official version at `https://web.stretchly.net`
options:
- label: I'm using official version
required: false
- type: checkboxes
id: known-issues
attributes:
label: Known issues
description: Please check [Known issues](https://github.com/hovancik/stretchly-for-web#known-issues) as it may containt a solution for your problem.
options:
- label: I've checked Known issues
required: true
- type: checkboxes
id: open-issues
attributes:
label: Existing issues
description: Please check [Existing issues](https://github.com/hovancik/stretchly-for-web/issues?q=is%3Aissue) as it may containt your issue already.
options:
- label: I've checked Existing issues
required: true
- type: dropdown
attributes:
label: What operating system are you using?
options:
- Windows
- macOS
- Linux
- Other (specify below)
validations:
required: true
- type: input
attributes:
label: Operating System Version
description: |
What operating system version are you using? On Windows, click Start button > Settings > System > About.
On macOS, click the Apple Menu > About This Mac.
On Linux, use lsb_release or uname -a.
placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04"
validations:
required: true
- type: dropdown
attributes:
label: What browser are you using?
options:
- Firefox
- Chrome
- Safari
- Other (specify below)
validations:
required: true
- type: input
attributes:
label: Browser Version
description: |
What operating system version are you using?
placeholder: "e.g. Firefox 89 or Chromium Version 97.0.4692.99"
validations:
required: true
- type: textarea
id: repro
attributes:
label: Reproduction steps
description: How do you trigger this bug? Please walk us through it step by step.
value: |
1.
2.
3.
...
**Reproduces how often:** [What percentage of the time does it reproduce?]
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: A clear description of what actually happens.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
[Learn here](https://github.com/hovancik/stretchly-for-web#debugging) how to get logs.
render: shell
validations:
required: false
- type: textarea
id: preferences
attributes:
label: Preferences
description: |
Please copy and paste your preferences if you made any changes to Preferences. This will be automatically formatted into code, so no need for backticks.
[Learn here](https://github.com/hovancik/stretchly-for-web#debugging) how to get it.
render: shell
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional information
description: Any additional information, configuration or data that might be necessary to reproduce the issue.
render: shell
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hovancik/stretchly-for-web/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature request]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
**Filling this report is required and failure to do so will result in closing the request.**
- type: checkboxes
id: version
attributes:
label: Version
description: We only support the official version at `https://web.stretchly.net`
options:
- label: I'm using official version
required: false
- type: checkboxes
id: open-requests
attributes:
label: Existing requests
description: Please check [Existing requests](https://github.com/hovancik/stretchly-for-web/issues?q=is%3Aissue) as it may containt your idea already.
options:
- label: I've checked Existing requests
required: true
- type: dropdown
attributes:
label: What operating system are you using?
options:
- Windows
- macOS
- Linux
- Other (specify below)
validations:
required: true
- type: input
attributes:
label: Operating System Version
description: |
What operating system version are you using? On Windows, click Start button > Settings > System > About.
On macOS, click the Apple Menu > About This Mac.
On Linux, use lsb_release or uname -a.
placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04"
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem description
description: Is your feature request related to a problem? Please describe.
value: |
A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Possible solution
description: Describe the solution you'd like
value: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative solutions
description: Describe alternatives you've considered
value: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional information
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hovancik/stretchly-for-web/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!--
Have you read Code of Conduct? By filing an Pull Request, you are expected to comply with it, including treating everyone with respect: https://github.com/hovancik/stretchly-for-web/blob/master/CODE_OF_CONDUCT.md
-->

Issue: #
<!-- Link to relevant issue. All PRs should be associated with an issue -->

### Requirements

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.

<!-- If there’s a checkbox you can’t complete for any reason, that's okay, just explain in detail why you weren’t able to do so. -->

- [ ] issue was opened to discuss proposed changes before starting implementation. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...).
- [ ] during development, `node` version specified in `package.json` was used (ie using [nvm](https://github.com/creationix/nvm)).
- [ ] package versions and package-lock.json were not changed (`npm install --no-save`).
- [ ] app version number was not changed.
- [ ] all new code has tests to ensure against regressions.
- [ ] `npm run lint` reports no offenses.
- [ ] `npm run test` is error-free.
- [ ] README and CHANGELOG were updated accordingly.
- [ ] after PR is approved, all commits in it are [squashed](https://gitbetter.substack.com/p/how-to-squash-git-commits)

### Description of the Change

<!--
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->


### Verification Process

<!--
What process did you follow to verify that your change has the desired effects?
- How did you verify that all new functionality works as expected?
- How did you verify that all changed functionality works as expected?
- How did you verify that the change has not introduced any regressions?
Describe the actions you performed (e.g., buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed.
-->


### Other information
25 changes: 25 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Node.js CI

on: [push, pull_request]

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]

steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v2
with:
node-version: '14.18.3'
- run: npm install npm -g
- run: npm install
- run: npx nyc --reporter=lcov npm test
env:
CI: true
- name: Codecov
uses: codecov/[email protected]
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npm run lint
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [0.0.1] - 2022-01-22
### Added
- basic funcionality of Mini and Regular breaks
- ability to Start, Resume, Pause and Stop breaks
- simple Preferences (intervals and durations for Mini and Regular breaks)
- debug information

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...HEAD
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making 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:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## 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 to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
Loading

1 comment on commit 50e0f1a

@vercel
Copy link

@vercel vercel bot commented on 50e0f1a Jan 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.