Cheerify

An iOS affirmation app designed to boost your spirits and promote positivity – built for Global Hack Weeks at MLH.

Table of Contents

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

About The Project

Cheerify is a mobile application for iOS designed to uplift and inspire users through affirmations. In today's fast-paced world, it's easy to feel overwhelmed or discouraged. Cheerify aims to combat these feelings by providing users with daily doses of positivity and encouragement, while allowing them to customize the application and leveraging in-app functionality to provide the best positive experience.

• Personalized Affirmations: Cheerify delivers tailored affirmations based on user preferences.
• Daily Reminders: Users receive notifications to engage with affirmations regularly, promoting a positive mindset throughout the day.
• Customizable Experience: Users can customize their affirmation experience by selecting favorite affirmations.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Cheerify is built for iOS. A device which can compile code for iOS is a prerequisite to making code enhancements and fixing bugs.

Installation

1. Clone the repo

   git clone https://github.com/KarolinaGroszewska/Cheerify.git

(back to top)

Roadmap

• Designing a logo for Cheerify
• Update this README.md with application screenshots
• Creating a custom Cheerify API wiht affirmations and affirmation categories
• Save affirmations locally and securely on-device

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

(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

(back to top)

License

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

(back to top)

Contact

Kari Groszewska - @techwithkari

Project Link: https://github.com/KarolinaGroszewska/Cheerify

(back to top)