BloomTech-Labs/future-hope-fe

Web App for virtual mentors (mostly in US) to support rural schools in Africa # Future-Hope-Client > Ready For Stakeholder Branch ## Table of Contents - **Project Overview** - **Install** - **Deploy** - **Components** - **Auth** - **Store** - **Usage** - **API** - **Maintainers** - **Contributing** - **License** ## Project Overview There are not enough qualified teachers in Ghana for the number of students that need to be taught. On the flip side, retired persons in North America report reduced quality of life because fo the feeling of a 'lack of purpose' after retirement. To combat these problems, we are teaming up with a stakeholder to develop web and iOS applications that connect teachers and students in Ghana with retired persons in North America. We hope to build applications that will enhance teacher education that is almost unavailable locally throug joint planning between teachers and North American virtual mentors. We'll be using in-app video conferencing and messaging apps to facilitate communication between retirees and teachers in Ghana. In order to facilitate these communications, we will design an on-boarding process that allows registered (and approved) users to schedule meetings with one another. ## Install ``` 1. Fork the repository 2. CD into the Future-Hope-Client directory 3. *Yarn* to install dependencies 4. *Yarn start* to fire up the app on your local server ``` ## Deploy Deployed on Netlify. Staging server QA server Production server ## Components #### The structure of this documentation is broken up by folder. ``` Starting with the src root folder, the flow will be as follows: > src > components > component folder > component sub-folder > component.js files ``` ### FAQ folder --- | Name | Purpose | How To View | | ------ | -------------------------------- | -------------- | | FAQ.js | onboarding process & general FAQ | head to '/faq' | ### Messaging folder --- | Name | Purpose | How To View …