Skip to content

Commit

Permalink
Merge pull request #86 from VocaDB/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
up2code authored Oct 13, 2019
2 parents 597b96c + d20cc92 commit 7c04a3c
Show file tree
Hide file tree
Showing 843 changed files with 41,243 additions and 30,605 deletions.
22 changes: 0 additions & 22 deletions .babelrc

This file was deleted.

70 changes: 0 additions & 70 deletions .flowconfig

This file was deleted.

10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,12 @@ yarn.lock
.idea
.tmp
ios/Pods
ios/VocaDB/GoogleService-Info.plist
ios/VocaDB/GoogleService-Info.plist
.packages
*.lock
build
android/key.local.properties
android/.gradle
android/**/*.iml
ios/Flutter/Generated.xconfig
ios/Runner/GeneratedPluginRegistrant.*
1 change: 0 additions & 1 deletion .watchmanconfig

This file was deleted.

86 changes: 0 additions & 86 deletions App.js

This file was deleted.

9 changes: 0 additions & 9 deletions LICENSE

This file was deleted.

81 changes: 8 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,20 @@
# VocaDB App
New VocaDB app with React native. Now available on [Android](https://play.google.com/store/apps/details?id=com.coolappz.Vocadb) and [iOS](https://itunes.apple.com/us/app/vocadb/id907510673).

[![Build Status](https://www.bitrise.io/app/424cdc66aab2e8e1/status.svg?token=1OdgCmNWesLCEyd0bUABsw)](https://www.bitrise.io/app/424cdc66aab2e8e1)

![Screenshot](/resources/screenshot/android/home.png)
VocaDB mobile version with [Flutter framework](https://flutter.dev/).

## Download

- [Playstore for Android](https://play.google.com/store/apps/details?id=com.coolappz.Vocadb)
- [Playstore (Alpha/Beta)](https://play.google.com/apps/testing/com.coolappz.Vocadb)
- [App Store for iOS](https://itunes.apple.com/us/app/vocadb/id907510673)

## Setup on local

### Prerequisite
- [NodeJS](https://nodejs.org/en/)
- [react-native-cli](https://www.npmjs.com/package/react-native-cli)
- [Storybook](https://storybook.js.org) like a component dictionary.

### Install

```shell
$ git clone https://github.com/VocaDB/VocaDB-App.git
$ cd VocaDB-App
$ npm install
```

### Storybook

In case if you never used storybook before
```shell
$ npm i -g @storybook/cli
```

Then you can start storybook by running

```shell
$ npm run storybook
```

### Run App

#### iOS
Mac OS Only. You must have Xcode installed first.

```shell
$ react-native run-ios
```

#### Android
## Setup for development
- [Flutter SDK](https://flutter.dev/docs/get-started/install)

```shell
$ react-native run-android
```

Getting started instruction is [here](https://facebook.github.io/react-native/docs/getting-started.html)

#### Using storybook

See in `App.js` file.

- Export `StorybookUI` if you want to run with storybook.
- Export `App` if you want to test real app.

### Config
in *src/constants/config* you can switch **useMock** to **false** to fetch real data from VocaDB API instead of mock.
## Editor (Optional)
- [Visual Studio Code](https://code.visualstudio.com/)
- [Android Studio](https://developer.android.com/studio)
- [IntelliJ](https://www.jetbrains.com/idea/download/)

## Translation

VocaDB App use [react-native-i18n](https://github.com/AlexanderZaytsev/react-native-i18n) for translation. Translation files are locate at *src/common/i18n/locales*.

All files will named by locale code. (Check at https://www.science.co.il/language/Locale-codes.php)

You can contact me for add more translation or add/edit by your own (Clone project, Create feature branch, Edit and pull request to me)

## Assets

Icon and splash images are inside *resources* directory.

- Icon 1024x1024 px

- Splash 2208x2208 px

Generated with [React Native Toolbox](https://github.com/bamlab/generator-rn-toolbox)
**WIP**
65 changes: 0 additions & 65 deletions android/.gitignore

This file was deleted.

Loading

0 comments on commit 7c04a3c

Please sign in to comment.