-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#1, Updated Readme file with the basic requirement
- Loading branch information
1 parent
14d8629
commit 91ed7f3
Showing
1 changed file
with
21 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,33 @@ | ||
| This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli). | ||
| # Workout Tracker App | ||
|
|
||
| # Getting Started | ||
| ## Overview | ||
|
|
||
| >**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding. | ||
| The Workout Tracker App is a mobile application developed using React Native to help users log and track their daily workout routines. The app allows users to select from a list of exercises categorized by different muscle groups and record details of their workout sessions. This app is ideal for fitness enthusiasts looking to monitor their exercise routines. | ||
|
|
||
| ## Step 1: Start the Metro Server | ||
| ## Usage | ||
| - Select Muscle Group: Choose a muscle group (e.g., biceps, triceps, chest) to view related exercises. | ||
| - Log Workout: For each exercise, record sets, reps, and weights used. | ||
| - Track Progress: The app provides a workout history that shows the progress made over time. | ||
| - Add Custom Exercises: Add new exercises if they’re not available in the predefined list. | ||
|
|
||
| First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native. | ||
| ## Tech Stack | ||
| - React Native: For building the mobile application. | ||
| - JavaScript/TypeScript: Core development language for logic and UI components. | ||
| - AsyncStorage: For local data storage. | ||
| - NativeWind (Optional): For UI styling. | ||
|
|
||
| To start Metro, run the following command from the _root_ of your React Native project: | ||
| ## Installation | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm start | ||
| 1. Clone the repository: | ||
|
|
||
| # OR using Yarn | ||
| yarn start | ||
| ```Bash | ||
| git clone https://github.com/praveenraam/RN-Workout_Tracker.git | ||
| cd RN-Workout_Tracker | ||
| ``` | ||
|
|
||
| ## Step 2: Start your Application | ||
| 2. Install dependencies | ||
|
|
||
| Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app: | ||
|
|
||
| ### For Android | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm run android | ||
|
|
||
| # OR using Yarn | ||
| yarn android | ||
| ```Bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### For iOS | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm run ios | ||
|
|
||
| # OR using Yarn | ||
| yarn ios | ||
| ``` | ||
|
|
||
| If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly. | ||
|
|
||
| This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively. | ||
|
|
||
| ## Step 3: Modifying your App | ||
|
|
||
| Now that you have successfully run the app, let's modify it. | ||
|
|
||
| 1. Open `App.tsx` in your text editor of choice and edit some lines. | ||
| 2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes! | ||
|
|
||
| For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes! | ||
|
|
||
| ## Congratulations! :tada: | ||
|
|
||
| You've successfully run and modified your React Native App. :partying_face: | ||
|
|
||
| ### Now what? | ||
|
|
||
| - If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps). | ||
| - If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started). | ||
|
|
||
| # Troubleshooting | ||
|
|
||
| If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page. | ||
|
|
||
| # Learn More | ||
|
|
||
| To learn more about React Native, take a look at the following resources: | ||
|
|
||
| - [React Native Website](https://reactnative.dev) - learn more about React Native. | ||
| - [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment. | ||
| - [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**. | ||
| - [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts. | ||
| - [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native. |