Retrospectives & Self-evaluations
Productivity app focused on survey reviews.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
Follow this guide.
Installing
cd just-a-review-app
yarn
cd ios
pod install
Running Android
cd just-a-review-app
yarn start
yarn android
Running iOS
cd just-a-review-app
yarn start
yarn ios
Running the tests
e2e tests
Make sure you have an emulator named: Pixel_3a_API_30_x86 or change the name on ./github/workflows/android.yml
from Pixel_3a_API_30_x86
to your emulator name.
yarn build-detox-android
yarn test-detox-android-windows
(see windows versions of these commands).
And coding style tests
Run linter
yarn lint
(see windows versions of these commands)
Run unit tests
yarn test
Upgrading app version
You can upgrade the app version by patch
, minor
and major
.
yarn bump-patch
yarn bump-minor
yarn bump-major
Built With
- react-native 0.63.3 - App built based on this crossplatform framework.
- @react-navigation - Used as a navigation framework.
- @react-navigation/drawer - Used to display an drawer menu.
- @react-navigation/stack - Used to for drawer options.
- react-native-dotenv - Envi Variable Management.
- react-native-push-notification - Used for local reminders and notifications.
- redux - Global state management.
- @reduxjs/toolkit - Used to reduce redux boilerplate.
- redux-logger - Used only on development to inspect the redux store.
- redux-persist - Used to persist the data.
- redux-thunk - Used as middleware for future api support.
- reselect - Used to get data from the store.
- react-native-paper - Used as component library support.
- typescript - Used with ❤️.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Kyonru - Initial work - Kyonru
See also the list of contributors who participated in this project.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details