# Saral Quick Guide

* Is SARAL for you? - Discuss more [here](https://github.com/orgs/Sunbird-Saral/discussions/91)

## **Getting Started**

* What kind of team will you need? - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.3znysh7)
* What kind of hardware you need to run SARAL smoothly?
  * Saral backend Production deployment - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.2jxsxqh)
  * Saral backend local/dev setup - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.1t3h5sf)
* What are the prerequisites for installation?
  * Saral backend - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.30j0zll)
  * Saral frontend - [Refer](https://docs.google.com/document/d/1Z_9HBaB_I1vAM7FQ3XhNL0f0bkl8j4BN/edit?usp=share_link\&ouid=114303898945073408189\&rtpof=true\&sd=true)

## **Use Saral**

* How to setup the frontend (app) - [Refer](https://docs.google.com/document/d/1Z_9HBaB_I1vAM7FQ3XhNL0f0bkl8j4BN/edit?usp=share_link\&ouid=114303898945073408189\&rtpof=true\&sd=true)
* How to set up the backend
  * local/development setup - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.3dy6vkm)
  * Production deployment - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.44sinio)
* What is training the app, why is it necessary, what you get out of the box wrt training, how to train the app more?
  * SARAL uses ML model to detect digits/ alpha-numeric characters, so in order to get better accuracy in detection, training of the model is required. Steps to train [Refer](https://github.com/Sunbird-Saral/react-native-saral-sdk/tree/develop/ml_models)
* How to conduct a pilot for SARAL - KGBV assessments [Refer](https://docs.google.com/document/d/1SMV2VRhOpEB1n8foHdK70X1--KSI0CPl/edit?usp=share_link\&ouid=114303898945073408189\&rtpof=true\&sd=true)
* How to conduct QA testing on SARAL - [Refer](https://docs.google.com/document/d/1dQtFgG0kxlL0BQ0o-k4p8RPn9vdbI7K3/edit?usp=sharing\&ouid=108822542868117713442\&rtpof=true\&sd=true)
* Performance benchmarking of SARAL(production setup) - [Refer](https://docs.google.com/document/d/118ZMNR-1N4HsOyB61PwNJZWcpuscalrS/edit?usp=sharing\&ouid=108822542868117713442\&rtpof=true\&sd=true)
* How to conduct a full-scale rollout of SARAL for my use case - NAT assessment case study in UP [Refer](https://docs.google.com/document/d/1SMV2VRhOpEB1n8foHdK70X1--KSI0CPl/edit?usp=share_link\&ouid=114303898945073408189\&rtpof=true\&sd=true)

## **How to Enhance Saral**

* What all aspects of the app are configurable - [Refer](/learn/features/configurable-branding.md)
* How to create & add a new form in SARAL for assessments?
  * To create new form layout you can use this tool. [Refer](https://github.com/Sunbird-Saral/Saral-Layout-Generator/blob/main/README.md)
  * After form layout is created take a pdf printout and follow this doc to generate ROI [Refer](https://docs.google.com/document/d/1hLWCCaj0DlX9uaMOFDY331ZIqDcnfGjRhGJdqpYJMRg/edit)
* How to make customizations in the app and still be able to get SARAL upgrades?\
  A front end developer with React native skills should be able to customize and upgrade refering this documentation

## **Monitor SARAL**

* How can I monitor the health of my instance - [Refer](https://docs.google.com/document/d/1pLTSwwak-u9CGl1IMyFbeFmgHH69kG_e/edit#heading=h.1pxezwc)
* How can I track the usage of the instance ( telemetry)?\
  Through play console & firebase

## **Support & contribute**

* How can I seek support for SARAL?\
  Through github discussion forum [Link](https://github.com/orgs/Sunbird-Saral/discussions)
* How can I suggest improvements for SARAL?\
  Through github discussion forum [Link](https://github.com/orgs/Sunbird-Saral/discussions)

## Want to experience Saral?

Write to us about your usecase [here](https://github.com/orgs/Sunbird-Saral/discussions)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://saral.sunbird.org/saral-quick-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.