34 lines
944 B
Markdown
34 lines
944 B
Markdown
# terminally-online
|
|
|
|
Terminally Online is a meme collection organizer powered by React Native.
|
|
|
|
## Setup
|
|
|
|
### Node
|
|
|
|
This project uses node 18. You can install [nvm](https://github.com/nvm-sh/nvm) and run `nvm use` in the project root to get the correct version.
|
|
|
|
### Dependencies
|
|
|
|
Install node dependencies with `npm install`.
|
|
|
|
## Testing
|
|
|
|
The following commands can be used to lint the codebase, run tests, and build the project with typescript:
|
|
|
|
```bash
|
|
npm run lint
|
|
npm run test
|
|
npm run build
|
|
```
|
|
|
|
## Installation
|
|
|
|
### Android
|
|
|
|
Use the instructions on the [React Native website](https://reactnative.dev/docs/environment-setup) to set up your environment. After that, you can run `npm run compile` to generate the APK.
|
|
|
|
### iOS
|
|
|
|
iOS devices are not supported and probably never will be. This is because Apple requires Mac device to build for iOS. See [this](https://reactnative.dev/docs/environment-setup#unsupported-1) for more information.
|