Sh**t! I Smoke
Know how many cigarettes you smoke based on the pollution of your location
📱 Try it on Expo
This app is bootstrapped with Expo, you can download the Expo app on the App Store or Play Store, and enter the url provided below. We have 2 release channels:
| Release Channel | Version | Description | Url |
|---|---|---|---|
| Production | v1.5.7 | Same version as Sh**t! I Smoke on the App Store and Play Store. | https://exp.host/@amaurymartiny/shoot-i-smoke?release-channel=production-v1.5.7 |
| Staging | v1.6.2 | Latest version currently in development: newest features, may contain bugs. | https://exp.host/@amaurymartiny/shoot-i-smoke |
🔨 Build it yourself
Run the following commands:
# Clone this repo
git clone https://github.com/amaurymartiny/shoot-i-smoke && cd shoot-i-smoke
# Install dependencies
yarn install
# Copy the file that contains secrets
cp app.example.json app.json
# Run the app with Expo
yarn startThe Expo packager will show, and you can either:
- install the Expo app, scan the displayed QR code, and run the app on your mobile phone directly.
- open the Android simulator.
- open the iOS simulator.
Use your own API tokens
All required API tokens are already pre-filled in app.example.json. If you want to use your own API tokens, then in app.json, replace all the placeholders with the ones you generated for yourself. For those that are optional, you can just put null (without quotes).
| Service | Url | Comments |
|---|---|---|
| Sh**t! I Smoke Backend | https://github.com/shootismoke/backend | Required. Pre-filled with a staging token. |
| World Air Quality Index | http://aqicn.org/api/ | Required. You can use the public one in app.example.json for development. |
| Google Maps for iOS | https://developers.google.com/maps/documentation/ios-sdk/start | Optional in development. |
| Google Maps for Android | https://developers.google.com/maps/documentation/android-api/ | Optional in development. |
| Sentry Bug Tracking | https://sentry.io | Optional. |
| Amplitude Analytics | https://amplitude.com | Optional. Note: we never track PII. |
🙋 Contribute
If you find a bug, or if you have an idea for this app, please file an issue here. We really appreciate feedback and inputs!
🇬🇧🇫🇷🇪🇸🇨🇳 You may also contribute with translations with our online tool POEditor. If you need context for some terms, here are some screenshots.
For code contribution, the codebase heavily relies on functional programming principles via the fp-ts library. The codebase itself is quite simple, so even if you're beginner to functional programming, it shouldn't be hard to follow along. You can start with these easy tasks.
More information on contributing here.
🔬 Tests
The codebase unfortunately isn't much covered by tests. Check out the *.spec.ts files in the project for tests. If you're interested to help out, have a look at issue #19.
📰 License
GPL-3.0. See LICENSE file for more information.
⭐ Credits
Created with pride by Marcelo & Amaury.
A huge thanks to the following contributors for their amazing work:
