3Cs documentation

Documentation

3Cs - A Sadhguru Center for Conscious Planet Platform

About

3Cs is a research app owned by Sadhguru Center for Conscious Planet aimed to explore how meditative practices affect consciousness , cognition and emotional well being.
3Cs Platform comprises a web portal and a mobile ( iOS , Android ) app .

Web Portal : Researchers can create , configure and push studies through the web portal in a matter of a few minutes.

Features
  • Configure Open and Closed group studies.
  • Configure Consent forms
  • Randomization of users into pre-defined groups.
  • Create, provision, push Surveys to the enrolled users .
  • Create, provision, push Cognitive tests to the enrolled users .
  • Configure well being , activities relevant to the study.
  • Track participants progress for Surveys , Cognitive tests , Activity log , Sleep Data.
  • Send app notifications.
  • Send email notifications.
  • Download Survey results.
  • Download Cognitive test results.
  • Download Consent forms submitted.

Mobile App : A mobile app would be available in iOS and Android app stores for participants to download the app and participate in the research studies.

Features:
  • Email , Google login.
  • View Open Research studies , eligibility criteria for enrollment.
  • Enroll for eligible studies.
  • Once enrolled , users would be able to access the following modules :
    • Study Instructions / Next Steps
    • Signed Consent form.
    • Surveys
    • Cognitive tests
    • Activities
    • Well Being metrics
    • Food log
    • Connect and Sync wearable device Data ( Fitbit , Apple watch )
    • Sleep ( Manual )

Modules/Pages

It consists of 4 main modules/pages:

Dashboard module

Features include :

  • Sleep, Activity weekly summary.
  • Graphical representation of data Insights of Activities and the Well being metrics

Activity module

Features include :

  • Activity log
  • Well Being questions
  • Food log

Health module

Features include :

  • Connect Fitbit and Apple Wearable devices
  • Sync device data
  • View Sleep and Heart rate information breakdown per each day
  • Add Manual Sleep

Profile module

Features include :

  • Profile information
  • Push Notifications
  • Contact information.

    Survey module

Features include :

  • Surveys
  • Cognitive tests

    Getting started

  1. Go to project folder and install dependencies:
    npm install
  2. Launch development server, and open localhost:4200 in your browser:
npm start / ng serve

To use different port you can use:

ng serve --port <port number> i.e 4300
  1. Login credentials
You can either login via Google/Facebook
Or
You can sign up to the platform
  1. Running locally on IOS
    Locally: ionic capacitor run ios --livereload --external

Debug application:

  1. Open Safari
  2. Open developer menu
  3. Click on developer
  4. Select the default IP on which your application is running
  5. You can find it under capacitor.config.json

Running locally on Android

Locally: ionic capacitor run android --livereload --external

Debug application:

Debug: Visit -> chrome://inspect/devices

Below IP click on Inspect

  1. Running Application in Build mode

Run the following commands:

Running by making build:
ionic cap sync
ionic build
npx cap update ios/android (If done any changes)
npx cap sync ios/android
npx cap copy ios/android
npx cap open android

Project structure

Pages/Modules/Components

For reff: https://docs.google.com/document/d/1JiDvJO_SYC7rnkgC_xsIjP5rRDQ1fqAMlJ7AvGN7LTw/edit?usp=sharing

IOS/Android structure

Pages/Modules/Components

For reff: https://docs.google.com/document/d/1JiDvJO_SYC7rnkgC_xsIjP5rRDQ1fqAMlJ7AvGN7LTw/edit?usp=sharing

Running 3Cs application :

Android

Locally: ionic capacitor run android --livereload --external Debug: Visit -> chrome://inspect/devices

Running 3Cs application :

IOSs

Locally: ionic capacitor run ios --livereload --external Debug: Visit -> safari -> develop -> click inspect {{running ip}}

Running by making build:

Build

ionic cap sync
ionic buil
npx cap update ios/android (If done any changes)
npx cap sync ios/android
npx cap copy ios/android
npx cap open android

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

You should not use ng serve directly, as it does not use the backend proxy configuration by default.

Firebase

-Firebase console

-[Firebase Notification]

Ionic and Capacitor: https://capacitorjs.com/docs/guides/push-notifications-firebase

Push Notification:

1.https://www.freecodecamp.org/news/how-to-get-push-notifications-working-with-ionic-4-and-firebase-ad87cc92394e/#2-firebase-setup-for-ios-and-android

Libraries

Coding guides

Other documentation

results matching ""

    No results matching ""