{"id":26494996,"url":"https://github.com/shootismoke/webapp","last_synced_at":"2025-03-20T10:33:15.071Z","repository":{"id":36990036,"uuid":"212374620","full_name":"shootismoke/webapp","owner":"shootismoke","description":"Sh**t! I Smoke web application","archived":false,"fork":false,"pushed_at":"2023-03-06T02:13:39.000Z","size":15586,"stargazers_count":28,"open_issues_count":22,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-12T23:18:25.353Z","etag":null,"topics":["air-pollution","air-quality","aqi","cigarette","climate-change","hacktoberfest","nextjs","pollution"],"latest_commit_sha":null,"homepage":"https://shootismoke.app","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shootismoke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":"amaurym","custom":"https://www.paypal.me/amaurym10/20"}},"created_at":"2019-10-02T15:20:29.000Z","updated_at":"2023-07-06T07:43:20.000Z","dependencies_parsed_at":"2023-02-16T03:00:36.393Z","dependency_job_id":"8e9e8509-d6fe-4aee-97ac-d6205c528b3e","html_url":"https://github.com/shootismoke/webapp","commit_stats":{"total_commits":272,"total_committers":8,"mean_commits":34.0,"dds":0.4742647058823529,"last_synced_commit":"be481f2e5f4f2d076c614a641e0c62d86dc1fac0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shootismoke%2Fwebapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shootismoke%2Fwebapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shootismoke%2Fwebapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shootismoke%2Fwebapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shootismoke","download_url":"https://codeload.github.com/shootismoke/webapp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244595235,"owners_count":20478435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["air-pollution","air-quality","aqi","cigarette","climate-change","hacktoberfest","nextjs","pollution"],"created_at":"2025-03-20T10:32:17.270Z","updated_at":"2025-03-20T10:33:15.048Z","avatar_url":"https://github.com/shootismoke.png","language":"HTML","funding_links":["https://github.com/sponsors/amaurym","https://www.paypal.me/amaurym10/20"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" style=\"background-color: #F8A65D;\"\u003e\n    \u003cimg alt=\"oss image\" src=\"https://shootismoke.app/static/logo_text_2lines-cf697d3ebc27c385cd2f30e1f6a68c51.svg\" width=\"300px\"\u003e\n\u003c/p\u003e\n\u003ch4 align=\"center\"\u003eKnow how many cigarettes you smoke based on the pollution of your location.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/shootismoke/webapp/actions\"\u003e\n    \u003cimg alt=\"Github Actions\" src=\"https://github.com/shootismoke/webapp/workflows/CI/badge.svg?branch=master\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/github/shootismoke/webapp/maintainability\"\u003e\n    \u003cimg alt=\"codeclimate\" src=\"https://api.codeclimate.com/v1/badges/9fc8ebb000978f14b6d0/maintainability\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://spectrum.chat/shootismoke\"\u003e\n    \u003cimg alt=\"spectrum\" src=\"https://withspectrum.github.io/badge/badge.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n## :rocket: Website: https://shootismoke.app\n\n## :hammer: Build it yourself\n\nRun the following commands:\n\n```bash\n# Clone this repo\ngit clone https://github.com/shootismoke/webapp \u0026\u0026 cd webapp\n\n# Install dependencies.\nyarn install\n\n# Fill in secret tokens.\ncp .env.example .env.development\n\n# Run the MongoDB daemon locally.\nmongod --dbpath /path/to/my/db\n\n# Run the app.\nyarn dev\n```\n\nThe webapp will launch at http://localhost:3000. It uses [Next.js](https://nextjs.org/), you can check out [their docs](https://nextjs.org/docs/).\n\n\u003e Note: A Docker images is [in the works](https://github.com/shootismoke/webapp/issues/115).\n\n### Use your own API tokens\n\nFor local development, all API secret tokens should live in the `.env.development` file for development, as described [in the Next.js docs](https://nextjs.org/docs/basic-features/environment-variables).\n\n| Env Variable                                           | Description                                                                                           | Url                                 | Comments                                                                                                  |\n| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------- |\n| `NEXT_PUBLIC_AQICN_TOKEN`                              | World Air Quality Index, used in frontend.                                                            | http://aqicn.org/api                | Required. You can use the public one in `.env.example` for development.                                   |\n| `NEXT_PUBLIC_SENTRY_API_KEY`                           | Sentry bug tracking.                                                                                  | https://sentry.io                   | Optional.                                                                                                 |\n| `NEXT_PUBLIC_AMPLITUDE_API_KEY`                        | Amplitude analytics                                                                                   | https://amplitude.com               | Optional. Note: we respect [DNT](https://en.wikipedia.org/wiki/Do_Not_Track), and we **never** track PII. |\n| `BACKEND_SECRET`                                       | Secret used in headers between frontend and backend API calls. Please note that CORS is also enabled. | n/a                                 | Required. Defaults to `ssshhh!` .                                                                         |\n| `BACKEND_AQICN_TOKEN`                                  | World Air Quality Index, used in backend.                                                             | http://aqicn.org/api                | Required. You can use the public one in `.env.example` for development.                                   |\n| `BACKEND_MAILGUN_API_KEY` and `BACKEND_MAILGUN_DOMAIN` | Credentials used for sending emails with Mailgun.                                                     | https://www.mailgun.com/            | Optional. Only used in the [script to send emails](./scripts/email.ts).                                   |\n| `BACKEND_MONGODB_ATLAS_URI`                            | Connection string to MongoDB.                                                                         | https://www.mongodb.com/cloud/atlas | Required. Defaults to `mongodb://localhost/shootismoke`.                                                  |\n\n## :raising_hand: Contribute\n\nIf you find a bug, or if you have an idea for this app, please [file an issue here](https://github.com/shootismoke/webapp/issues). We really appreciate feedback and inputs!\n\nMore information on contributing [here](./CONTRIBUTING.md).\n\n## :microscope: Tests\n\nThe codebase is covered by different types of tests:\n\n-   Unit tests: located in the `src/` folder, next to the tested files, and end with `.spec.ts{x}`.\n-   Backend E2E tests: located in `test/e2e/backend`.\n-   Frontend E2E tests: located in `test/cypress`, using [Cypress](https://www.cypress.io).\n\n## :newspaper: License\n\nGPL-3.0. See [LICENSE](./LICENSE) file for more information.\n\n## :star: Credits\n\nCreated with pride by [Marcelo](http://www.marcelocoelho.cc) \u0026 [Amaury](https://amaurym.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshootismoke%2Fwebapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshootismoke%2Fwebapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshootismoke%2Fwebapp/lists"}