https://github.com/azgaar/peer-rewards

Tiny React application
https://github.com/azgaar/peer-rewards

Last synced: over 1 year ago
JSON representation

Tiny React application

• Host: GitHub
• URL: https://github.com/azgaar/peer-rewards
• Owner: Azgaar
• Created: 2021-06-18T10:34:06.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-07-06T13:28:43.000Z (almost 5 years ago)
• Last Synced: 2025-02-01T02:30:51.422Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 1.55 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ![icon](https://user-images.githubusercontent.com/26469650/122673740-83d85280-d1da-11eb-98ce-85873d6d8d75.png) Peer Rewards

Client-side application that allows employees to receive and assign rewards. The app demo is available at [peer-rewards.netlify.app](https://peer-rewards.netlify.app/).

![peer-review-screenshot](https://user-images.githubusercontent.com/26469650/122673382-e597bd00-d1d8-11eb-9167-3c08164320e2.png)

## Features

- Modern responsive design

- Smooth CSS transitions

- Optional image avatars

- Fully-functional routing

- Data mockups in .json

## Tech stack

This is a [React](https://reactjs.org/) application bootstrapped with [Create React App](https://github.com/facebook/create-react-app) for a fast and clean start and written in [TypeScript](https://www.typescriptlang.org/).

It uses [Material UI](https://material-ui.com/) as UI framework as it helps to start immediately building modern-looking GUI without significant efforts or customization.

[Formik](https://formik.org/) and [Yup](https://github.com/jquense/yup) are used for fast and well-tested form validation. [Day.js](https://day.js.org/) is used for dates formatting.

Tests are ran using [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) and [Jest](https://jestjs.io/). Pre-commit linting is set with [Husky](https://github.com/typicode/husky).

## Installation and U

Clone the repository and install the dependencies, then execute `start` to run the app in development mode:

```

git clone https://github.com/Azgaar/peer-rewards.git

cd peer-rewards

yarn

yarn start

```

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

**`yarn test`**: launches the test runner in the watch mode.

**`yarn build`**: builds the app for production to the `build` folder.