Initial commit

Signed-off-by: Nikolaos Karaolidis <nick@karaolidis.com>
This commit is contained in:
2023-07-08 17:47:05 +03:00
commit cca5cf6781
54 changed files with 28103 additions and 0 deletions

33
README.md Normal file
View File

@@ -0,0 +1,33 @@
# 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.