Expo Preview

DanceBlue Mobile

DanceBlue's mobile app is a great way to interact with DanceBlue year round from the comfort of your phone
Explore DanceBlue

Donate · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

DanceBlue is a University of Kentucky student-run organization that fundraises year-round and culminates in a 24-hour no sitting, no sleeping dance marathon. The money raised through DanceBlue is donated to the Golden Matrix Fund, established to support the kids of the DanceBlue Kentucky Children’s Hospital Hematology/Oncology Clinic both today and well into the future through an endowment. DanceBlue funds also support the year-long fundraising engine and operations that underpin the mission, as well as providing funds to support research at the UK Markey Cancer Center. The Golden Matrix Fund was created to benefit the DanceBlue KCH Hematology/Oncology Clinic patients and families. Childhood cancer not only affects the child physically, but it also creates many emotional and financial difficulties for the entire family. The goal of the Golden Matrix Fund is to provide care and support for the kids through giving them and their parent’s comfort.

(back to top)

Built With

• React Native
• Expo
• yarn
• VS Code

(back to top)

Getting Started

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

Getting up and running

1. Run yarn install to install project dependencies, this will take some time
2. Install the development build of the app on your phone (contact the app coordinator if you have an iPhone)
3. Run yarn start (or ctrl+shift+b in VSCode) to start Expo's testing environment
4. Scan the QR code Expo generates with your phone's camera
5. You should now be able to work on the code and hot reload the app on expo go as you work
6. In VSCode you can also activate the "attach to packager" debug configuration to interactively debug the app using VSCode's built-in debugger

Building

See Expo's guide on "distributing your app"

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you are interested in joining DanceBlue, send me a message (see my contact info)!

Some notes for contributors

• Naming convention for files is:
  • PascalCase for files that represent a single entity (i.e. a type or component) unless it is a plain function
  • camelCase for files that represent a collection of entities (i.e. an index file, a collection of values, multiple unrelated exports) or a plain function
  • Folders that are intended to be imported directly should match the case of their subject (i.e. PascalCase for a folder with a component)
  • kebab-case for other folders
• ESlint has rules for most other cases, it is highly recommended to install the eslint plugin for your editor or keep eslint --watch running in the background

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Tag Howard - [email protected]

Project Link: https://github.com/UKDanceBlue/danceblue-react-app

(back to top)

Acknowledgments

• Tag Howard - Current App Coordinator
• Kenton Carrier - Original development
• Everyone on the DanceBlue committee

(back to top)