Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaocarmo/litten-app
🐈 Litten mobile app repository
https://github.com/joaocarmo/litten-app
adoption android animals app firebase ios litten mobile non-profit react-native
Last synced: about 2 hours ago
JSON representation
🐈 Litten mobile app repository
- Host: GitHub
- URL: https://github.com/joaocarmo/litten-app
- Owner: joaocarmo
- License: agpl-3.0
- Created: 2020-04-04T11:50:15.000Z (over 4 years ago)
- Default Branch: next
- Last Pushed: 2024-05-02T09:08:20.000Z (7 months ago)
- Last Synced: 2024-05-02T22:11:53.448Z (7 months ago)
- Topics: adoption, android, animals, app, firebase, ios, litten, mobile, non-profit, react-native
- Language: TypeScript
- Homepage: https://litten.app
- Size: 9.96 MB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Litten
Litten mobile app repository using React Native and Firebase.
## Development Commands
```sh
# Install dependencies
yarn install
# Install the cocoapods dependencies
yarn pods
# Run the Android simulator
yarn android
# Run the iOS simulator
yarn ios
# Run the ES linter
yarn lint
# Run Prettier
yarn pretty
# Run the type checker (TypeScript)
yarn type-check
# Run the tests
yarn test
# Prepare the data dependencies
yarn prepare-data
# This will seed the Firestore DB with some data
yarn firestore:seed
# This will start the Firebase Emulator
yarn start:firebase
```
## Generic account
After seeding the Firestore DB, a generic account can be used right away.
```txt
email: [email protected]
password: thisisthepassword
```
## Environment
Customize the environment variables, some functions might fail due to lack of
certain API keys.
```sh
cp .env.example .env
cp android/secure.properties.example android/secure.properties
```
The `GOOGLE_API_KEY` needs to be available for the location functions.
Detailed instructions on how to setup the environment are available
[here][env-setup].
## Backend
Currently, the project relies on a [Firebase][firebase] infrastructure. The app
will fail to build until a new project is [setup][setupfirebase] and the
`GoogleService-Info.plist` configutarion file is added to the `ios` directory,
as well as the `google-services.json` file to `android/app`.
Additionally, you should install, configure and integrate the
[Local Emulator Suite][emulator].
```sh
# Install the Firebase Tools
npm install -g firebase-tools
```
### Current API dependecies
- [Google Maps (Geocoding)][googleapikey]
- [Jira][jira] (Report Problems)
- [Slack][slack] (Report Problems)
## License
The project's source code is licensed as [AGPL-3.0][license], but the images and
the design are [not licensed][licenseimgs].
[emulator]: https://firebase.google.com/docs/emulator-suite/install_and_configure
[env-setup]: https://reactnative.dev/docs/environment-setup
[firebase]: https://firebase.google.com
[googleapikey]: https://developers.google.com/maps/documentation/geocoding/get-api-key
[jira]: https://www.atlassian.com/software/jira
[license]: ./LICENSE
[licenseimgs]: ./lib/images/README.md
[setupfirebase]: https://firebase.google.com/docs/ios/setup
[slack]: https://slack.com