Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brittanyarima/Steps

Open Source Step Counting App using HealthKit & SwiftUI
https://github.com/brittanyarima/Steps

hacktoberfest healthkit ios-swift swiftui

Last synced: 3 months ago
JSON representation

Open Source Step Counting App using HealthKit & SwiftUI

Awesome Lists containing this project

README

        

## ๐ŸƒSteps

This app is open source and ready for you to contribute! Built fully with SwiftUI and open to contributers of any experience level (beginners welcome๐Ÿ™‚)!

# Getting Started
* Read the [Code of Conduct](https://github.com/brittanyarima/Steps/blob/main/CODE_OF_CONDUCT.md)
* Read the [CONTRIBUTING.md](https://github.com/brittanyarima/Steps/blob/main/CONTRIBUTING.md) guidelines
* Download Xcode 15 or later, and macOS 14.0 or later
* Browse the open [issues](https://github.com/brittanyarima/Steps/issues) and **comment** which you would like to work on
* Fork this repo
* Clone the repo to your machine
* In the same folder that contains the `StepsConfigTemplate.xcconfig`, run this command, in Terminal, to create a new Xcode configuration file (which properly sets up the signing information)

```sh
cp StepsConfigTemplate.xcconfig StepsConfig.xcconfig
```

* In the StepsConfig.xcconfig file, fill in your `DEVELOPMENT_TEAM` & `BUNDLE_ID`
* Example: `DEVELOPMENT_TEAM = IdNumber` & `BUNDLE_ID = com.name.steps`
* You can find your Team ID by logging into the Apple Developer Portal
* This is only needed when running on a real device for iOS, this works with both free or paid Apple Developer accounts.
*
* You will need to do this AGAIN to set up the Widget extension

```sh
cp StepsWidgetConfigTemplate.xcconfig StepsWidgetConfig.xcconfig
```
* โ—๏ธMake sure you at .widget to this `PRODUCT_BUNDLE_IDENTIFIER` ie. com.name.steps.widget
* Build the project

* Checkout a new branch (from the `dev` branch) to work on an issue
Checkout any issue labeled `hacktoberfest` to start contributing.

* Start contributing!
* Submit PR to merge with `dev` branch
* If you've never contributed to open-source before there are a ton of great tutorials out there to help get you started
* Issues labeled `good-first-issue` are great for beginners.








**Tech Used**
- ๐ŸŽจ SwiftUI
- โค๏ธโ€๐Ÿฉน HealthKit
- ๐Ÿ“Š Swift Charts
- ๐Ÿ”” Local Notifications
- ๐Ÿ—‚๏ธ MVVM
- ๐Ÿ’พ App Storage


# Contributors


Made with [contrib.rocks](https://contrib.rocks).

# License
This project is licensed under [MIT License](https://github.com/brittanyarima/Steps/blob/main/LICENSE).