Comment on page
Workspace Setup - Playbook
Developer Environment Setup - Playbook
- 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)
- Jupyter Notebook 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 codegit clone https://github.com/Sunbird-Saral/Project-Saral.git.
Change Directory toProject-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
- Setting up the React Native development environment Note: Choose
React Native CLI Quick Start
tab for setup instructions. - 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). - Register on Google Firebase, add the Saral project on the firebase dashboard and download the corresponding google-services.json.
- 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.
- From Saral release
v1.5.4
and above, please execute below commands from $BACKEND_FOLDER in a terminal.
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
Build docker image using
docker build . -t saral-backend:1.0-latest the
command from $BACKEND_FOLDER folder in a Terminal.- 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"
Last modified 1yr ago