/HearMeOut

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Hear Me Out.

There is someone to listen, understand and help you.

status status GitHub issues


About   Setup   Testing  


About The Project

Hear Me Out is a platform where you can share your thoughts with experts. We choose our experts carefully. The Experts are some really kind-hearted people who are there to listen to your stories without any judgments. Every expert posses a common quality and that is they are Good Listener.


Aim

The HMO platform is made for people to talk out the experiences, thoughts, and everything they wish to share anonymously with someone who will not judge them in any aspect. The platform connects you with some verified experts who will listen to your thoughts and express his/her opinion. The expert may not give you a proper solution for your problem as this is not a consultation platform, but he/she will be there for you to listen to your problems and share his/her thoughts.

"Sometimes we don't need a solution but we need someone to hear us out."

This is where 'Hear Me Out' will help you.


For Whom?

The HMO platform will connect you with someone according to your age group (Minimum Age - 16). The audience is divided into two categories.

  1. Young - Age Group (16 to 54)
  2. Super Young - Age Group (55 +)

(Feature under construction) --> HMO rates the expert based on your facial expressions. (we don't monitor your expressions) But a AI based model tracks your facial expressions and rates the expert who is talking to you.


Setup

The Project runs on @Nibella serverless platform which hosts the frontend and takes care of everything in the backend. The front end is developed in React.js, Basic HTML/CSS and javascript, JQuery. The React Project is stored in react-src directory. On Windows You can execute yarn deploy in react-src directory which will copy the contents from build directory to web directory inside Nimbella Project (HMO).

(Note - The above mentioned command works on windows using powershell. The shell version is in progress.)

Setup Commands - Use yarn of npm.

run yarn or npm install in the react-src directory. Create a Nimbella acount and then a nim Project.


Testing

Once you setup the Nimbella project and react frontend, Try running following commands-

  1. In HMO Directory run nim project deploy HMO.
  2. In react-src Directory run yarn start to run a local server.

To Test the front-end and API follow the following steps.

To build and test -

Windows -

  1. run yarn deploy or npm deploy inside your react-src directory.
  2. In HMO directory run nim project watch HMO.

Other -

  1. run yarn build or npm build inside your react-src directory.
  2. Copy the build directory contents to the HMO/web.
  3. In HMO directory run nim project watch HMO.

Note - Firebase is used for authentication, follow the following tutorial and paste your firebase keys in .env file.

Firebase Docs