{"id":25109897,"url":"https://github.com/glific/mobile","last_synced_at":"2025-06-20T10:35:06.994Z","repository":{"id":165045751,"uuid":"609656203","full_name":"glific/mobile","owner":"glific","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-10T22:09:22.000Z","size":3736,"stargazers_count":8,"open_issues_count":8,"forks_count":17,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-20T01:58:10.557Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glific.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-04T20:48:25.000Z","updated_at":"2024-06-10T22:09:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"868390d8-f53c-495b-be1b-a1469dc702c9","html_url":"https://github.com/glific/mobile","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glific%2Fmobile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glific%2Fmobile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glific%2Fmobile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glific%2Fmobile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glific","download_url":"https://codeload.github.com/glific/mobile/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249984006,"owners_count":21355995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-08T00:32:44.440Z","updated_at":"2025-04-21T01:42:24.143Z","avatar_url":"https://github.com/glific.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Glific mobile\n\n## Getting Started\n\n### Prerequisites\n\n- Nodejs \u003e=@18.16.0\n- Android SDK\n- Yarn \u003e=@v1.22.19\n\n### Setup\n\nThe following setup helps you to run the application on an android machine. Read the [documentation](https://reactnative.dev/docs/running-on-simulator-ios) of react-native to know about running it on iOS devices.\n\n1. Clone the repository\n\n```sh\ngit clone git@github.com:glific/mobile.git\n```\n\nYou can also use https to clone the repository. To know more read this [documentation](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#clone-with-https).\n\n2. Now change the directory by navigating into the cloned repository. Use the following command, in case of linux.\n\n```sh\ncd mobile\n```\n\n1. Create an environment file in the project's home directory with the filename `.env`, copy the contents from `.env.example` and update the key-value pairs based on the current environment the application is running in.\n\n2. Install the dependencies using yarn.\n\n```sh\nyarn install\n```\n\n1. Start the metro server.\n\n```sh\nyarn start\n```\n\nNote that you need to connect either an android device or an emulator with your PC to run the application.\n\n### Testing (Android phone)\n\n- Download Expo Go app from playstore\n- Scan the QR from your CLI\n\n## Contributing\n\n### Pull Request Submission Guidelines\n\nWhen submitting a pull request, please ensure that it meets the following requirements:\n\n- The code passes all relevant unit test cases.\n- The pull request references the related issue and clearly explains the problem it aims to solve.\n- The code has been scanned for any deepscan issues and none are present.\n- The code follows the project's formatting guidelines and has been formatted using prettier.\n\nPlease make sure to address all the checkboxes above before submitting your pull request. This will help in ensuring the quality and maintainability of the project.\n\n## Developer Guidelines\n\n### Theme Constants Usage\n\nImport the project theme constants from the constants folder:\n\n```sh\nimport { COLORS, SIZES, FONTS, SCALE } from '/path/to/constants';\n```\n\nHere are the project theme constants available for usage:\n\n- **COLORS**: Contains color-related constants, ex. `COLORS.primary400`.\n- **SIZES**: Includes size-related constants, ex. `SIZES.m10`, `SIZES.r4` etc.\n- **FONTS**: Provides font-related constants, ex. `...FONTS.regular14`.\n- **SCALE**: Offers custom scaling constants which are not included in SIZES for text and other UI elements, ex. `SCALE(100)`.\n\nRefer to the /constants/theme.ts file containing the project theme constants.\n\n### Naming Convention for testID and class\n\n- For `testID` and `class` attributes used in your code, follow the camelCase naming convention.\n- Use lowercase for the first letter of the attribute name and capitalize the first letter of subsequent words within the name.\n\nExample:\n\n```jsx\n// Correct:\n\u003cView testID=\"myElement\" className=\"myComponent\" /\u003e\n\n// Incorrect:\n\u003cView testID=\"my_element\" className=\"my_component\" /\u003e\n\u003cView testID=\"my element\" className=\"my-component\" /\u003e\n```\n\nFollowing these guidelines helps to ensure a smoother development process and easier maintenance.\n\nIf you have any questions or need further assistance, feel free to reach out to the project team. Happy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglific%2Fmobile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglific%2Fmobile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglific%2Fmobile/lists"}