Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stefandeveloper/scrum-retroboard

Electron App to enhance the Sprint Retrospective of Scrum
https://github.com/stefandeveloper/scrum-retroboard

babel electron electron-app eslint flowtype reactjs redux scrum scrum-board

Last synced: 6 days ago
JSON representation

Electron App to enhance the Sprint Retrospective of Scrum

Awesome Lists containing this project

README

        






A Scalable Cross-Platform Desktop Apps based on Electron, React, Redux, React Router, Webpack and React Hot Loader to enhance the Scrum Retrospective.


















[![Github Tag][github-tag-image]][github-tag-url]
[![Appveyor Build Status][appveyor-image]][appveyor-url]
[![Build Status][travis-image]][travis-url]
[![Good first issues open][good-first-issue-image]][good-first-issue-url]
[![FOSSA Status][fossa-image]][fossa-url]
[![Codacy Badge][codacy-image]][codacy-url]

## Install

- **If you have installation or compilation issues with this project, please see [our debugging guide](https://github.com/stefanDeveloper/scrum-retroboard/issues/400)**

First, clone the repo via git:

```bash
git clone --depth 1 --single-branch --branch master https://github.com/stefanDeveloper/scrum-retroboard.git your-project-name
```

And then install the dependencies with yarn.

```bash
$ cd your-project-name
$ yarn
```

## Starting Development

Start the app in the `dev` environment. This starts the renderer process in [**hot-module-replacement**](https://webpack.js.org/guides/hmr-react/) mode and starts a webpack dev server that sends hot updates to the renderer process:

```bash
$ yarn dev
```

If you don't need autofocus when your files was changed, then run `dev` with env `START_MINIMIZED=true`:

```bash
$ START_MINIMIZED=true yarn dev
```

## Packaging for Production

To package apps for the local platform:

```bash
$ yarn package
```

## Docs

See our [complete docs here](https://github.com/stefanDeveloper/scrum-retroboard/wiki)

## Maintainers

- [Stefan Machmeier](https://github.com/stefanDeveloper)

## License

MIT © [Scrum Retroboard](https://github.com/stefanDeveloper/scrum-retroboard)

[github-tag-image]: https://img.shields.io/github/tag/stefanDeveloper/scrum-retroboard.svg?label=version
[github-tag-url]: https://github.com/stefanDeveloper/scrum-retroboard/releases/latest
[good-first-issue-image]: https://img.shields.io/github/issues/stefanDeveloper/scrum-retroboard/good%20first%20issue.svg?label=good%20first%20issues
[good-first-issue-url]: https://github.com/stefanDeveloper/scrum-retroboard/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue"
[appveyor-image]: https://ci.appveyor.com/api/projects/status/33f3ukwrwv3xr22a?svg=true
[appveyor-url]: https://ci.appveyor.com/project/stefanDeveloper/scrum-retroboard/branch/master
[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2FstefanDeveloper%2Fscrum-retroboard.svg?type=shield
[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2FstefanDeveloper%2Fscrum-retroboard?ref=badge_shield
[travis-image]: https://travis-ci.org/stefanDeveloper/scrum-retroboard.svg?branch=master
[travis-url]: https://travis-ci.org/stefanDeveloper/scrum-retroboard
[codacy-image]: https://api.codacy.com/project/badge/Grade/9ac3a109038141af913794d323a040b7
[codacy-url]: https://app.codacy.com/app/stefanDeveloper/scrum-retroboard?utm_source=github.com&utm_medium=referral&utm_content=stefanDeveloper/scrum-retroboard&utm_campaign=Badge_Grade_Dashboard