An iOS affirmation app designed to boost your spirits and promote positivity – built for Global Hack Week at MLH. This README was a part of a stream too!
Table of Contents
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.
To get a local copy running, follow these steps
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/KarolinaGroszewska/Cheerify.git
- Install NPM packages
npm install
- Enter your API in
config.jsconst API_KEY = 'ENTER YOUR API';
- Feature 1
- Feature 2
- Feature 3
- Nested Feature
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Your Name - @twitter_handle - email@email_client.com
Project Link: https://github.com/KarolinaGroszewska/Cheerify