{"id":18340105,"url":"https://github.com/coding-nerfilio/mindfulness","last_synced_at":"2025-04-09T20:41:26.242Z","repository":{"id":243589168,"uuid":"812835515","full_name":"coding-nerfilio/mindfulness","owner":"coding-nerfilio","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-10T01:44:53.000Z","size":383,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-15T12:51:04.749Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coding-nerfilio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-10T01:26:38.000Z","updated_at":"2024-06-10T01:44:56.000Z","dependencies_parsed_at":"2024-06-10T02:43:01.395Z","dependency_job_id":"9b830bf8-75b3-42e5-b9a1-3052acd4189c","html_url":"https://github.com/coding-nerfilio/mindfulness","commit_stats":null,"previous_names":["coding-nerfilio/mindfulness"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coding-nerfilio%2Fmindfulness","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coding-nerfilio%2Fmindfulness/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coding-nerfilio%2Fmindfulness/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coding-nerfilio%2Fmindfulness/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coding-nerfilio","download_url":"https://codeload.github.com/coding-nerfilio/mindfulness/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248109801,"owners_count":21049379,"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":[],"created_at":"2024-11-05T20:21:00.012Z","updated_at":"2025-04-09T20:41:26.225Z","avatar_url":"https://github.com/coding-nerfilio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔥 Firebase PWA Starter\nThis is an opinionated Progressive Web App (PWA) starter. This template focuses on emulating a seamless native mobile experience, ensuring there's no unnecessary overscroll. Get ready to build powerful PWAs with a touch of elegance!\n\n## Tech Stack\nReact PWA with Material UI and Firebase\n\n## Preview\n\nNo overscroll or mismatching status bars, looks just like a native mobile application! 😊\n\n\u003cimg src=\"https://github.com/nc1z/react-pwa-starter/assets/111836326/e978cb85-3a52-47d9-a406-490c1d393f8c\" alt=\"pwa-result\" width=\"300\"\u003e\n\n## Getting Started\n\n### Local Development\nFollow these steps to set up the project for local development:\n\n1. Run the command to spin up the PWA starter:\n    ```bash\n    npx create-react-app my-app --template cra-template-firebase-pwa-starter\n    ```\n    or if you are already in a new directory for your project\n    ```bash\n    npx create-react-app . --template cra-template-firebase-pwa-starter\n    ```\n    This also installs all the necessary dependencies to get you started.\n\n2. Start the development server:\n\n    ```bash\n    npm start\n    ```\n3. Congratulations! Now you have a working PWA. Now if you want to deploy your PWA on Firebase, please follow the guide in the next few sections.\n\n## Optional\n### Firebase Setup\nFirst setup your project in Firebase\n\n1. Create a \u003ca href=\"https://firebase.google.com/\"\u003eFirebase account\u003c/a\u003e\n2. Go to your \u003ca href=\"https://console.firebase.google.com/\"\u003eFirebase Console\u003c/a\u003e\n3. Create a new project. \u003ca href=\"https://www.firebasemaster.com/setup/how-to-create-firebase-project\"\u003e[guide]\u003c/a\u003e\n4. Register your app \u003ca href=\"https://www.firebasemaster.com/setup/how-add-web-app-to-firebase-project\"\u003e[guide]\u003c/a\u003e\n### Deployment\n\nPlease make sure you have a \u003ca href=\"#firebase-setup\"\u003efirebase project\u003c/a\u003e setup.\n\nTo deploy your application to a staging environment and access it on your mobile device, follow these steps.\n\nMake sure you have \u003ca href=\"https://firebase.google.com/docs/cli\"\u003eFirebase CLI\u003c/a\u003e installed\n\n```bash\nnpm install -g firebase-tools\n```\n\nIf you haven't already, log in to Firebase and initialize it in your repository.\n\nFor a step-by-step deployment guide, check out this \u003ca href=\"https://www.knowledgehut.com/blog/web-development/deploying-react-app-to-firebase\"\u003earticle\u003c/a\u003e\n\nOnce initialization is completed, you can use the following scripts for deployment:\n\n### `deploy:dev`\nDeploys to the Firebase `development` environment for preview.\n\n### `deploy:prod`\nDeploys to the Firebase `live` production environment.\n\n### `deploy:list`\nShows a list of running environments.\n\n## Building New Pages\n\nWhen creating new pages, you'll should create the page components in the `src/views` folder. These components serve as the main content body.\n\n![image](https://github.com/nc1z/react-pwa-starter/assets/111836326/9e67e871-8bff-4d34-a998-196b14a23eff)\n\nThe parent container uses a class called `PageContainer`, which enables overscroll, touch action, and overflow.\n\n```tsx\nconst AboutPage = () =\u003e {\n    return (\n        \u003cdiv className=\"PageContainer\"\u003e\n            // Child elements and components here\n        \u003c/div\u003e\n    )\n}\n\nexport default AboutPage\n```\n\nTake a look at the `src/views/Home` component for reference. \n\nFor style customizations, check out `src/App.css`.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoding-nerfilio%2Fmindfulness","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoding-nerfilio%2Fmindfulness","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoding-nerfilio%2Fmindfulness/lists"}