Skip to content

Commit

Permalink
Update readme for devs (#227)
Browse files Browse the repository at this point in the history
  • Loading branch information
duogenesis authored Mar 29, 2024
1 parent b3ae981 commit ad8bfb7
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 45 deletions.
47 changes: 47 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Developer instructions

## Starting The Server

You might need to run this the first time you run the Duolicious frontend:

```bash
export NODE_OPTIONS=--openssl-legacy-provider
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
```

```bash
npm install
npx patch-package

# If you want to use the real (production) backend server, you can set these
# environment variables
export DUO_STATUS_URL=https://status.duolicious.app
export DUO_API_URL=https://api.duolicious.app
export DUO_CHAT_URL=wss://chat.duolicious.app
export DUO_IMAGES_URL=https://user-images.duolicious.app

npx expo start
```

## Building the Android APK

Add these to `~/.gradle/gradle.properties`:

```
DUOLICIOUS_UPLOAD_STORE_FILE=duolicious.keystore
DUOLICIOUS_UPLOAD_KEY_ALIAS=duolicious
DUOLICIOUS_UPLOAD_STORE_PASSWORD=*****
DUOLICIOUS_UPLOAD_KEY_PASSWORD=*****
```

Then:

```bash
./build-apk.sh
```

If you want to install the APK:

```
adb install android/app/build/outputs/apk/release/app-release.apk
```
48 changes: 3 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,5 @@
# duolicious-frontend
# Duolicious Frontend

## Starting The Server
There's screenshots of the app at https://github.com/duolicious.

You might need to run this the first time you run the Duolicious frontend:

```bash
export NODE_OPTIONS=--openssl-legacy-provider
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
```

```bash
npm install
npx patch-package

# If you want to use the real (production) backend server, you can set these
# environment variables
export DUO_STATUS_URL=https://status.duolicious.app
export DUO_API_URL=https://api.duolicious.app
export DUO_CHAT_URL=wss://chat.duolicious.app
export DUO_IMAGES_URL=https://user-images.duolicious.app

npx expo start
```

## Building the Android APK

Add these to `~/.gradle/gradle.properties`:

```
DUOLICIOUS_UPLOAD_STORE_FILE=duolicious.keystore
DUOLICIOUS_UPLOAD_KEY_ALIAS=duolicious
DUOLICIOUS_UPLOAD_STORE_PASSWORD=*****
DUOLICIOUS_UPLOAD_KEY_PASSWORD=*****
```

Then:

```bash
./build-apk.sh
```

If you want to install the APK:

```
adb install android/app/build/outputs/apk/release/app-release.apk
```
If you want development instructions, see [DEVELOPER.md](DEVELOPER.md).

0 comments on commit ad8bfb7

Please sign in to comment.