Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/protokol/collectibles-mobile

Last synced: about 10 hours ago
JSON representation

Host: GitHub
URL: https://github.com/protokol/collectibles-mobile
Owner: protokol
License: other
Created: 2021-02-03T14:47:18.000Z (almost 4 years ago)
Default Branch: develop
Last Pushed: 2024-06-27T01:32:45.000Z (5 months ago)
Last Synced: 2024-06-27T04:22:08.286Z (5 months ago)
Language: TypeScript
Size: 65.7 MB
Stars: 0
Watchers: 9
Forks: 1
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

![Img](collectibles-mobile.png)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

# Digital cards mobile app

A mobile app consuming a set of `@protokol` packages providing Digital Asset (NFT) Support. Supporting the following main features:

- wallet management
- digital card ownership

For more information and detailed documentation follow this link: https://docs.protokol.com/nft/.

This work is licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).

## Production Install
App is available on:

- [Web](https://protokol.github.io/collectibles-mobile)
- [Android](https://protokol.github.io/collectibles-mobile)
- [iOS](https://protokol.github.io/collectibles-mobile)

[comment]: # (TODO: Replace Android and iOS links to Google Play & App Store)

## Source Install

Copy .env.template to .env and configure properly
Keep REACT_APP_PAPER_COINS_FAUCET_SENDER_PASSPHRASE empty to disable Faucet funcionality

Be sure you don't publish any passphrase for real money production environments

Configure REACT_APP_GOOGLE_MAPS_API_KEY with your Google Maps API key to show app locations properly

### Development Environment Setup

Run `npm start` for a dev server. The application will open in your default browser.

Run `npm run build` to create build folder.

Run `npm run build:android:ci` and after `npm run cap:start:android` for a dev Android application.
Running Android application requires Android Studio to be installed.
Note: If you cant find the folder capacitor-cordova-android-plugins inside the android project folder, you need to run a capacitor command to create it (and update plugin variables): Run `npx cap sync`

Run `cap:start:ios` for a dev iOS application.
Running iOS application requires XCode to be installed.

### Source Code Setup

```bash
git clone https://github.com/protokol/collectibles-mobile
cd collectibles-mobile

# run npm install from root folder
npm install

# install ionic cli tool
npm install -g @ionic/cli
```

#### Running on Android SDK
Create, if not exists, local.properties file at android folder with next line:
sdk.dir=[path to ANDROID SDK FOLDER]

```
npm run build:android:ci (Windows users: npm run win:build:android:ci)
npm run cap:start:android
```
#### Running Unit Tests

Run `npm run test` to execute the unit tests via [Jest](https://jestjs.io/).

###Building with Ionic AppFlow

Android: "prebuild" script will be executed after "build"

# Contact Us For Support And Custom Development

[email protected]

# License

[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

This work is licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/), under the following terms:

#### Attribution

You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

#### NonCommercial

You may not use the material for commercial purposes. For commercial purposes please reach out to [email protected].

#### ShareAlike

If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

#### Legal code

Read the rest of the obligatory [license legal code](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode).