/react-meditation-app

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Medit8

Take a break. Meditate

Explore the docs »

View Demo · Report Bug · Request Feature



Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Contact

About The Project

(back to top)

Built With

  • ReactRouter
  • EmailJs
  • Firebase
  • ReactJs
  • Material UI
  • Redux
  • Howler

(back to top)

Getting Started

To get a local copy of the project up and running follow these simple example steps.

Prerequisites

  • Install Node.js
  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/alisherkhan98/react-meditation-app.git
  2. Install NPM packages

    npm install
  3. Now if you want to open a live server to start developing type this in your terminal:

    npm start

    otherwise if you want to build the final files bundeled with webpack type

    npmm run build

    This will create a new dist folder with the built files in it

(back to top)

Usage

The app is very basic, if you are not signed in you can do it, you can sign up or you can sign in as a guest to try the features.

Once you are signed in, in the home page you can see a collection of cards and if you click on any of them a player will appear (the one you see in the screenshots) to play the related sound.

You can add sounds to your favorites list and if you are signed in with a non-anonymous account they will be saved.

(back to top)

Error handling

If an error occurs with any of the authentication functions the promise chain is aborted and an alert appears on the top to explain what happened.

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)

Contacts

Email: asherkhan982@gmail.com

My LinkedIn

Project Link: https://github.com/alisherkhan98/react-meditation-app

(back to top)