Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. About UX/UI
5. License
6. Contact

About The Project

Gym notes is designed to replace your paper workout journal. With this application you will be able track your workouts and gains in the gym (application was created for educational purposes).

(back to top)

Built With

• React Native
• Typescript
• Expo
• React Native Elements

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

• expo

  npm install --global expo-cli

Installation

1. Clone the repo

   git clone https://github.com/gym-notes/mobile.git

2. Install NPM packages

   npm install

3. Enter your API in helpers/AxiosInterceptors.ts

   const BASE_URL = 'ENTER YOUR API';

4. Start the project

   expo start

(back to top)

Roadmap

• User authentication & authorization
• Create plan
  • Add exercise to the plan
  • Remove exercise from the plan
• Delete plan
• Create workout
  • Add exercise to the workout
  • Remove exercise from the workout
• Workouts history
• Edit user profile
• User BMI
• Records

See the open issues for a full list of proposed features (and known issues).

(back to top)

About UX/UI

Fima project: click here

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Kamil Nahotko - email: [email protected]

Project Link: https://github.com/gym-notes

(back to top)