https://github.com/intersective/practera-sdk-ionic
This is an angular 2/4 + Ionic 2 general SDK for interfacing with Practera
https://github.com/intersective/practera-sdk-ionic
Last synced: 5 months ago
JSON representation
This is an angular 2/4 + Ionic 2 general SDK for interfacing with Practera
- Host: GitHub
- URL: https://github.com/intersective/practera-sdk-ionic
- Owner: intersective
- License: apache-2.0
- Created: 2017-06-18T07:02:35.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T16:30:57.000Z (over 3 years ago)
- Last Synced: 2024-04-14T18:03:41.052Z (about 2 years ago)
- Language: TypeScript
- Size: 13.9 MB
- Stars: 1
- Watchers: 13
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Practera SDK - Ionic 2/Angular 2 (soon 4)
Overview
Docs
1. [Front-end Architecture](https://docs.google.com/document/d/1-6rO7WrnBSGQtbmnIXe-AukzQVsrDpPFM9YeS9r44X8/edit#heading=h.973rokhhmjm5)
1. [Naming Convention Planning](https://docs.google.com/document/d/1Q77qYA9IPTXmjhEMizZYNEBbJkEcbJbD34_1wyEY6iI/edit)
## Requirements
For development environment, here are mandatory utilities.
- __Npm (Nodejs)__ : Refer to https://nodejs.org/download/
- __Ionic v3__ : version 3++
## Setup Notes
1. Install dependencies
```bash
npm install -g ionic #install ionic-cli globally
```
1. Make sure your ionic is running at least v3 and above by running `ionic -v` command
```bash
ionic -v # example version number (> 3) from the command above
```
1. If you have problem installing ionic, please uninstall current version of ionic with the following and repeat the step 1 & 2 above again to install ionic correctly.
```bash
npm uninstall -g ionic
```
1. after git clone with `git clone git@github.com:intersective/practera-sdk-ionic.git`
1. change directory into the project folder `cd practera-sdk-ionic`
1. Install node dependencies
```bash
npm install
```
1. To run app locally
```bash
ionic serve
```
## Development Notes
1. Ionic Deeplinking/Routing
Deeplinking allow a URL to auto redirect user into a specific page in the App.
We also use named url parameters in URL, for example, ```http://example.com?parameter_name=example_value``` for specific feature to adapt backward-compatible consideration.
For example, using pagename in _do_ parameter:
- Reset password: `http://example.com?do=resetpassword&email=test@example.com&key=abcdefg`
- Registration: `http://example.com?do=registration&email=test@example.com&key=abcdefg`
1. Copy `src/configs/config.ts.default` to `src/configs/config.ts`. Change your appkey inside `config.ts` based on the appkey in your database.
1. Start server or initiate app
```
ionic serve
```
## Troubleshooting
1. **Cached web content** - If you found what you see in browser isn't updated as expected after you've changed the codebase, you can try:
1. Make sure `ionic serve` in your terminal if it is still running
1. Activate browser `Developer Mode` in Chrome/Safari/Firefox - `OPT + CMD + I`
1. Empty cache
1. Chrome
1. Application Tab
1. Clear Storage
1. click '[*Clear selected*]' button
1. Safari
1. Select `Develop`
1. Disable cache
1. Empty cache or `OPT + CMD + E`
1. Firefox
1. Get into `Preference` (use shortcut key `CMD + ,`)
1. Select `Advanced`
1. At the `Cached Web Content` click '[*Clear Now*]' button
1. To clear npm cache, if you get prompted about `node-sass`, run command below
```bash
npm rebuild node-sass
```
1. To make sure your npm package installed has the latest/match `package.json` dependencies correctly
```bash
# reinstall after node_modules & npm cache cleared
rm -fr node_modules
rm -fr package-lock.json
npm cache clean --force
npm install
```