Mendisphere

Mendisphere is a platform that helps nonprofit mental health organisations who are struggling financially, specifically with securing grants.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Mendisphere is a platform that helps nonprofit mental health organisations who are struggling financially, specifically with securing grants.

(back to top)

Built With

• 

(back to top)

Getting Started

Instructions on setting up your project locally.

Prerequisites

1. Node, npm are installed in your machine
2. Configure firebase emulators for the local development environment. Please refer to src/services/firebase/emulator-readme.md
3. If you are not using firebase emulator, please update the firebase config to bypass firebase emulator setup - refer to src/services/firebase/firebaseConfig.ts
4. Firebase app secrets stored in the root level of the project in file named: env.development.local

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install and run firebase emulator (optional) a. Please refer to src/services/firebase/emulator-readme.md for further instructions.
3. Install NPM packages

   npm install

4. Run the project locally

   npm start

5. If running firebase emulators, go to firestore emulator test page: http://localhost:3000/firestore-mock
6. Click on the "Upload mock data to firestore" button to add mock data to firestore emulator.

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

WIP

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. Assign yourself to an issue in the todo backlog (https://github.com/orgs/bettersg/projects/5)
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/bettersg/MindBetter-Frontend

(back to top)

Acknowledgments

(back to top)