Skip to content

Commit

Permalink
feat: add documnetation
Browse files Browse the repository at this point in the history
  • Loading branch information
enzo-mourany committed Jan 16, 2023
1 parent 3ae280d commit f6803dc
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Tabata App

This is a simple app to help you with your Tabata training. It is based on the [Tabata protocol](https://en.wikipedia.org/wiki/Tabata_protocol).

## How to use

1. Set the duration of exercise period
2. Set the duration of rest period
3. Set the number of rounds you want to do
4. Start Tabata !

## How to build

1. Install [Node.js](https://nodejs.org/en/) >= 16
2. Install [TypeScript](https://www.typescriptlang.org/)
3. Install [Xcode](https://developer.apple.com/xcode/) (IOS) or [Android Studio](https://developer.android.com/studio) (Android)

Install dependencies

```bash
npm install
```

Run the app (IOS)

- `cd ios && pod install`
- `npm run ios`

Run the app (Android)

- `cd android && ./gradlew clean`
- `npm run android`


## How to contribute

1. Fork the project
2. Create a new branch
3. Make your changes
4. Create a pull request
5. Wait for review
6. Merge your changes
7. Celebrate !

## License

[MIT](https://choosealicense.com/licenses/mit/)


## Acknowledgments

- [React Native](https://reactnative.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [React Navigation](https://reactnavigation.org/)

## Screenshots


## Author

[Enzo Mourany](https://enzomourany.com)

[GitHub](https:://github.com/enzo-mourany)

## Show your support

Give a ⭐️ if this project helped you!


0 comments on commit f6803dc

Please sign in to comment.