Workspace Setup - Playbook
Developer Environment Setup - Playbook
Last updated
Was this helpful?
Developer Environment Setup - Playbook
Last updated
Was this helpful?
NodeJs (Recommended version v16.9.1 LTS)
NPM
OpenJDK 8
NDK old Version 20.0.5594570 needed to be compatible. Use command sdkmanager 'ndk;20.0.5594570'
to switch to ndk 20.0.5594570. (This command is handy on Mac or Linux)
Saral SDK (This SDK is embedded in Saral App code base). Refer Saral SDK Source Code Repository
Docker to bring up reference backend as a container ()
for transforming VoTT raw json to Saral ROI json. Refer to source repository path specs\v1\README.md file for more details. You may consider installing the extension in MS Visual Studio Code.
PostMan or any other REST client tool to invoke/test Rest APIs.
Open Terminal and clone source code
git clone https://github.com/Sunbird-Saral/Project-Saral.git.
For latest repo refer
Source Code Repository
Change Directory to
Project-Saral/
folder and switch to release tag as per release notes.git checkout tags/<tag_name>
$FRONTEND_FOLDER = Project-Saral/v1.0/frontend
$BACKEND_FOLDER = Project-Saral/v1.0/backend
In Android Studio, navigate to File\Project Structure\SDK Location
and set Android NDK location to $ANDROID_HOME\ndk\android-ndk-r20 (extracted in the last step).
Once Vysor and AVD are configured as per the instructions, follow the below steps to bring up the application.
cd android && ./gradlew clean && cd ..
npx react-native run-android
Successful frontend deployment should show Saral OCR login screen on AVD or USB connected Android device.
Install node and MongoDB in your local machine.
cp ../../specs/v1.5/swagger-saral-maintenance.yaml ./src
cp ../../specs/v1.5/swagger-saral-frontend.yaml ./src
cp ../../specs/v1.5/swagger-saral-apidoc.yaml ./src
Create a subfolder inside the backend folder name it as configuration.
Now create a file in config\dev.env and paste the below commands
PORT=3000
MONGODB_URL=mongodb://localhost:27017/saraldata_dev
JWT_SECRET=SARALDATA_NODE
Successful backend local deployment should show Server is up on port 3000
Make sure the backend server is running
Command to delete/clean existing data:
node ./data/import-data.js --delete
Command to load data from data files in ./backend/data folder.
node ./data/import-data.js --import
https://www.npmjs.com/package/react-devtools Note: For the current version of Saral execute npm i -g react-devtools@"<4.11.0"
Note: Choose React Native CLI Quick Start
tab for setup instructions.
Download and extract archive to $ANDROID_HOME\ndk folder.
Make sure sdk.dir
paths are set properly in \SaralApp\android\local.properties.
Register on , add the Saral project on the firebase dashboard and download the corresponding google-services.json.
Place downloaded google-services.json
under /SaralApp/android/app folder.
Open a terminal in /SaralApp and run npm i
the command.
Make sure backend BASE_URL is configured in /SaralApp/src/configs/config.js file.
From Saral release v1.5.4
and above, please execute below commands from in a terminal.
Install npm packages by running npm i
from .
Run npm run dev
command from a terminal in .
Dockerfile is available under folder.
Build docker image using docker build . -t saral-backend:1.0-latest the
command from folder in a Terminal.
Docker swarm stack reference file available at /saralbackend-stack.yml
Docker-compose reference file available at /docker-compose.yml