Skip to content

Commit

Permalink
docs: update setup and testing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hassankhan committed Oct 14, 2024
1 parent acd6e1b commit 9a30ef4
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ jobs:
- uses: nrwl/nx-set-shas@v4

# Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
- run: bun nx affected -t lint test build
- run: bun nx affected -t lint
4 changes: 4 additions & 0 deletions .mise.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[tools]
# specify single or multiple versions
bun = '1.1.27'
node = 'prefix:22'
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# Kittygram

## Tech Stack

- [React Native](https://reactnative.dev/)
- [Expo](https://expo.io/)
- [Unistyles](https://reactnativeunistyles.vercel.app/)
- [RTK](https://redux-toolkit.js.org/)
- [Jest](https://jestjs.io/)
- [Detox](https://wix.github.io/Detox/)
- [TypeScript](https://www.typescriptlang.org/)
- [Nx](https://nx.dev/)
- [CatAPI](https://thecatapi.com/)

## Development

> [!NOTE]
> Make sure you've followed React Native's [prerequisites](https://reactnative.dev/docs/set-up-your-environment)
> [!NOTE]
> Remember to set your CatAPI API key environment variable in
> `apps/mobile/.env`. Use `.env.example` as a template.
```bash
git clone https://github.com/twodoorsdev/kittygram.git
cd kittygram
Expand All @@ -9,3 +30,25 @@ nx run mobile:run-android
# OR
nx run mobile:run-ios
```

## Running E2E tests

Before running the E2E tests, set in `apps/mobile/.env`.

> [!NOTE]
> Make sure you've followed Detox's [prerequisites](https://wix.github.io/Detox/docs/introduction/environment-setup)
> [!WARNING]
> Remember to set your environment variables in both `apps/mobile/.env` and
> `apps/mobile-e2e/.env` before running the tests. Specifically, make sure
> the CatAPI API key is the same in both files, and that `EXPO_PUBLIC_TEST_MODE`
> is `true` in `apps/mobile/.env`.
```bash
nx run mobile:prebuild --clean
nx run mobile:run-android
# OR
nx run mobile:run-ios
nx run mobile-e2e:build -- --configuration ios.sim.release
nx run mobile-e2e:test -- --configuration ios.sim.release
```
1 change: 1 addition & 0 deletions apps/mobile/.env.example
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
EXPO_PUBLIC_CAT_API_KEY=
EXPO_PUBLIC_TEST_MODE=false

0 comments on commit 9a30ef4

Please sign in to comment.