https://github.com/kabisa/kudos-frontend
The frontend for the Kudos-o-Matic! (Mobile / Desktop)
https://github.com/kabisa/kudos-frontend
kabisa kudos-o-matic react semantic teamwork typescript
Last synced: 3 months ago
JSON representation
The frontend for the Kudos-o-Matic! (Mobile / Desktop)
- Host: GitHub
- URL: https://github.com/kabisa/kudos-frontend
- Owner: kabisa
- Created: 2018-09-21T09:41:04.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-22T11:17:14.000Z (about 2 years ago)
- Last Synced: 2024-05-22T11:37:36.285Z (about 2 years ago)
- Topics: kabisa, kudos-o-matic, react, semantic, teamwork, typescript
- Language: TypeScript
- Homepage:
- Size: 59.6 MB
- Stars: 2
- Watchers: 26
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://codeclimate.com/github/kabisa/kudos-frontend/maintainability)
[](https://codeclimate.com/github/kabisa/kudos-frontend/test_coverage)
# Kudos-o-Matic Frontend
> React PWA app for the Kudo-o-matic platform!
Backend: https://github.com/kabisa/kudo-o-matic
## Quick start guide
### Prerequisites
- Node.js >=10 + NPM, for the build system
- Yarn >= 1, for package management
- Chrome v59.x or higher to run the tests headless
- Java 8 (or higher) to run the end-to-end tests (it powers the selenium server)
## Development workflow
- Running `yarn install` will hook you up with everything you'll need
- `yarn start` will start the development server on http://localhost:9090.
- To create a static HTML5 app build, run `yarn build`. The app will be built into the `dist/` directory.
- To run all tests, run `yarn test`.
## Environment variables
Create react app will automatically set NODE_ENV and load the correct configuration based on the way you started the application.
Running the app with `yarn start` will set the NODE_ENV to 'development' and running `yarn build` will use the production config.
All environment variables should be prefixed with `REACT_APP_`. Read more about it [here](https://create-react-app.dev/docs/adding-custom-environment-variables/).
### Required environment variables
`REACT_APP_API_BASE_URL`: The URL of the kudo-o-matic backend.
## Code formatting
Code formatting and style are enforced using ESLint.
You can run the `yarn lint:check` command to run an analysis.
You can use the ESLint auto fix feature by running `yarn lint:run`
## Slack integration
The frontend application requires no special action to make the Slack integration work.
See the [back-end docs](https://github.com/kabisa/kudo-o-matic/blob/develop/docs/SLACK_INTEGRATION.md) for more information.
## CI and deployment
The project is build using [GitHub actions](https://github.com/kabisa/kudos-frontend/actions) with every commit.
See the .github directory for the configuration file.
The project is hosted on [Netlify](https://app.netlify.com/teams/kabisa/sites) and deployed using commit hooks. If you need to access Netlify, please contact Managed Services for bobth environments.
The following environments exist:
- [Staging](https://kudos.develop.kabisa.io/)
- [Production](https://kudos.kabisa.io/)
To deploy a new version, create a new release on GitHub. The release will be automatically deployed to the environments when merging into develop (staging) or master (production).
## Contributing
### Step 1
- **Option 1**
- Fork this repo
- **Option 2**
- Clone this repo to your local machine using `https://github.com/kabisa/kudos-frontend.git`.
### Step 2
- **HACK AWAY!**
### Step 3
- Open a new pull request
## Team
| **Stefan Pahlplatz** |
| :--------------------------------------------------------------------------------------------------------------------: |
| [](https://github.com/StefanPahlplatz) |
| `github.com/stefanpahlplatz` |
---
## License
[](http://badges.mit-license.org)
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
- Copyright 2018 © Kabisa B.V..