Skip to content

Latest commit

 

History

History
109 lines (87 loc) · 5.25 KB

README.md

File metadata and controls

109 lines (87 loc) · 5.25 KB
Raw

Basic Car Maintenance

Static Badge GitHub last commit (branch) GitHub contributors first-timers-only Unit Tests Deploy DocC Documentation

Welcome to my open source app! It is ready for contributors for Hacktoberfest! Use this app to gain experience getting started in open source for iOS and macOS development using Swift and SwiftUI.

Getting Started

  • Read the Code of Conduct
  • Read the CONTRIBUTING.md guidelines
  • Download Xcode 15 or later (preferred to use Xcode 16 or later)
  • Browse the open issues and comment which you would like to work on
    • It is only one person per issue, except where noted.
  • Fork this repo
  • Clone the repo to your machine (do not open Xcode yet)
  • In the same folder that contains the Basic-Car-Maintenance.xcconfig.template, run this command, in Terminal, to create a new Xcode configuration file (which properly sets up the signing information)
cp Basic-Car-Maintenance.xcconfig.template Basic-Car-Maintenance.xcconfig

  • Open Xcode

  • In the Basic-Car-Maintenance.xcconfig file, fill in your DEVELOPMENT_TEAM and PRODUCT_BUNDLE_IDENTIFIER.

    • You can find this by logging into the Apple Developer Portal
    • This works with both free or paid Apple Developer accounts. Do NOT run this app on a real device due to issues with the Sign in With Apple capability.
DEVELOPMENT_TEAM = ABC123
PRODUCT_BUNDLE_IDENTIFIER = com.mycompany.Basic-Car-Maintenance

  • Build the project ✅

  • Setup the Firebase emulator:

    • Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Install Xcode command line tools
xcode-select --install
  • Install Node Version Manager (NVM)
brew install nvm
  • After installation, add the executable to your $PATH via your .zshrc or .bashrc file, and restart your Terminal as prompted.
  • Install the latest stable version of Node
nvm install stable
nvm use stable
  • Install OpenJDK
brew install openjdk
  • Install Firebase tools
npm install -g firebase-tools
  • This installs the Firebase tools necessary for running the emulator.

Warning

DO NOT skip setting up the emulators! or your app won't work

  • Start the emulator with: firebase emulators:start --import=./local-data --export-on-exit

    • Be sure to be in the backend folder that contains the firebase.json file.

  • Checkout a new branch, from the dev branch, to work on an issue

Contributing

To start contributing, review CONTRIBUTING.md. New contributors are always welcome to support this project.

👀 Please be sure to comment on an issue you'd like to work on and Mikaela Caron, the maintainer of this project, will assign it to you! You can only work on ONE issue at a time.

Checkout any issue labeled hacktoberfest to start contributing.

Important

View the GitHub Discussions for the latest information about the repo.

Issue Labels

  • first-timers-only is only for someone who has not contributed to the repo yet! (and is new to open source and iOS development)
  • good-first-issue is an issue that's beginner level

Please choose an appropriate issue for your skill level

Contributors

Made with contrib.rocks.

Star History

Star History Chart

License

This project is licensed under Apache 2.0.