Giter Club home page Giter Club logo

cc-doc's Introduction

Nyenyak Cloud Computing Documentation

Project Summary

Nyenyak uses Google Cloud Platform (GCP) and Firebase to develop a system capable of classifying sleep disorders, such as insomnia and sleep apnea, based on user data. Additionally, the system will provide actionable suggestions to enhance the sleep quality of users experiencing sleep disturbances. The project involves a collaboration between machine learning, mobile development, and cloud computing teams

Cloud Architecture

Architecture Illustration

1. Setup Google Cloud Platform

  • Create Project & Configure Identity and Access Management.
  • Enable the following APIs:
    • App Engine API
    • Cloud Run Admin API
    • Google Container Registry API
    • Firebase API (Management, Realtime Database, etc.)
    • Cloud Monitoring API
    • Cloud Logging API

2. Setup Firebase

  • Open Firebase, go to the console, and connect it to your Google Cloud Project.
  • Activate Firebase Auth & Firebase Realtime Database.
  • Create a Service Account and download the corresponding seviceAccountKey.json file.

3. Clone Project and Set Google Cloud Account

  • Open cloud shell or your preferred code editor (Visual Studio Code).
  • Clone the Nyenyak project from Nyenyak-Backend-Repo using the command git clone -b BackEnd https://github.com/w0n0g1ren/Nyenyak.git.
  • Initialize a Git repository with git init and connect it to your Google Cloud account.

4. Set Project and Deploy Application

  • In the terminal, set your project by executing gcloud config set project nyenyak-project-dev.
  • Deploy both nodeJS and model API to App Engine and Cloud Run.

6. API Documentation

Additional Backend Details:

  • Backend API is built using Node Express.js to handle user authentication, diagnosis, articles, and user details.
  • We deployed the backend API to App Engine for easier scalability and reliability.
  • A separate API for TensorFlow model, built using Flask and deployed to Cloud Run.
  • Utilize Cloud Monitoring & Logging for comprehensive resource monitoring and alerting.

Conclusion

The Nyenyak project integrates Google Cloud Platform and Firebase Realtime Database to create a robust and scalable solution. The backend architecture ensures efficient communication between the mobile app, backend API, and machine learning model, providing users with accurate sleep disorder diagnoses and solution for improvement.

===============================================

Nyenyak Cloud Computing Documentation

Status: Active Version: 1.0.0 Contributors: 2

Project Summary

Nyenyak is a capstone project aim to develop a system capable of classifying sleep disorders, such as insomnia and sleep apnea, based on user data. Additionally, the system will provide actionable suggestions to enhance the sleep quality of users experiencing sleep disturbances. It uses Google Cloud Platform and Firebase services to create a scalable and reliable solution that connects users, mobile apps, backend APIs, and machine learning models.

Table of Contents

Cloud Architecture

Architecture Illustration

Setup Google Cloud Platform

  • Create Project & Configure Identity and Access Management.
  • Enable the following APIs:
    • App Engine API
    • Cloud Run Admin API
    • Google Container Registry API
    • Firebase API (Management, Realtime Database, etc.)
    • Cloud Monitoring API
    • Cloud Logging API

Setup Firebase

  • Open Firebase, go to the console, and connect it to your Google Cloud Project.
  • Activate Firebase Auth & Firebase Realtime Database.
  • Create a Service Account and download the corresponding seviceAccountKey.json file.

Clone Project and Set Google Cloud Account

  • Open cloud shell or your preferred code editor (Visual Studio Code).
  • Clone the Nyenyak project from Nyenyak-Backend-Repo using the command git clone -b BackEnd https://github.com/w0n0g1ren/Nyenyak.git.
  • Initialize a Git repository with git init and connect it to your Google Cloud account.

Set Project and Deploy Application to App Engine and Cloud Run

  • In the terminal, set your project by executing gcloud config set project your-project.
  • Deploy both nodeJS and model API to App Engine and Cloud Run.
    • Navigate to the directory of your Node.js API and execute the following command gcloud app deploy.
    • Navigate to the Model API directory, build and push your docker image, then deploy the model API to Cloud Run by running this command gcloud run deploy --image gcr.io/nyenyak-project-dev/nyenyak-model-api

API Documentation

Additional Backend Details:

  • Backend API is built using Node Express.js to handle user authentication, diagnosis, articles, and user details.
  • We deployed the backend API to App Engine for easier scalability and reliability.
  • A separate API for TensorFlow model, built using Flask and deployed to Cloud Run.
  • Utilize Cloud Monitoring & Logging for comprehensive resource monitoring and alerting.

Conclusion

The Nyenyak project integrates Google Cloud Platform and Firebase Realtime Database to create a robust and scalable solution. The backend architecture ensures efficient communication between the mobile app, backend API, and machine learning model, providing users with accurate sleep disorder diagnoses and solution for improvement.

cc-doc's People

Contributors

canggihwr avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.