Skip to content

The official Github repo of HitPause

Notifications You must be signed in to change notification settings

tannerstern/HitPause

 
 

Repository files navigation

Welcome to the Github Repo for HitPause!

We have a Docs site! 💻

Check it out HERE!

App Live Link 📲

The most up to date published app lives HERE!

Getting Started 🚀

Helpful Links

Installation
  1. Node Make sure you have Node installed. You can check by running node -v. If you do not, go to NodeJS.org and follow the installation instructions.
  2. Expo After Node is installed, in your command line/terminal, run npm install expo-cli --global. Download the Expo Client on your phone from the App Store or Google Play.
  3. If you haven't already, make a fork of this Github Repo, and then clone this Github Repo from your fork to your local machine.
  4. In your command line/terminal, get into the directory of this app. cd .../HitPause
  5. Run npm install to download all of the app dependancies. This might take a little bit.
Running the App
  1. Once npm finished installing and you have downloaded the client on your phone, run the expo start command. This will start up the app and it should boot up Expo DevTools in your web browser. Use your camera/QR code scanner to scan the QR code and open the app on your mobile device. If you get an error when trying to open on your phone about "unable to resolve @expo/vector-icons" let me know. Alternatively, you can choose to open the app in your browser and use the browser's mobile simulation features through the inspector.
  2. In your favorite IDE, you can start making changes to the app. The best place to start is HitPause/screens/HomeScreen.js
  3. Save the file and watch the screen update in real time!

Contributing 🎉

To add your code to this repository, please follow these steps

  1. Make sure your codebase is up to date.
  2. Put all changes on their own branch with a descriptive name.
  3. Create a pull request. As the title, put the name of the story associated with the feature you are pushing. Ex for a story named "Feature - Profile Page" title the PR "Story - Feature - Profile Page" so we can keep the backlog and the code well tracked.
  4. Ask someone on the team to review your PR, it can't be merged until then!

About

The official Github repo of HitPause

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%