{"id":20876192,"url":"https://github.com/chrispoulter/halcyon","last_synced_at":"2025-03-12T16:19:41.519Z","repository":{"id":41329754,"uuid":"242955134","full_name":"chrispoulter/halcyon","owner":"chrispoulter","description":"A react web project template 👷 Built with a sense of peace and tranquillity 🙏","archived":false,"fork":false,"pushed_at":"2025-02-14T15:14:17.000Z","size":3510,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-14T15:43:42.021Z","etag":null,"topics":["docker","eslint","github-actions","prettier","react","react-hook-form","react-router","shadcn-ui","tailwindcss","tanstack-query","typescript","vite","zod"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrispoulter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-02-25T09:03:09.000Z","updated_at":"2025-02-14T15:14:21.000Z","dependencies_parsed_at":"2023-10-20T17:33:28.408Z","dependency_job_id":"c9209f95-b626-4677-9b34-43c67b5855bd","html_url":"https://github.com/chrispoulter/halcyon","commit_stats":null,"previous_names":["chrispoulter/halcyon-next","chrispoulter/halcyon"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrispoulter","download_url":"https://codeload.github.com/chrispoulter/halcyon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243249007,"owners_count":20260768,"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":["docker","eslint","github-actions","prettier","react","react-hook-form","react-router","shadcn-ui","tailwindcss","tanstack-query","typescript","vite","zod"],"created_at":"2024-11-18T06:50:22.166Z","updated_at":"2025-03-12T16:19:41.514Z","avatar_url":"https://github.com/chrispoulter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Halcyon\n\nA react web project template 👷 Built with a sense of peace and tranquillity 🙏\n\n## Features\n\n- Vite\n  [https://vite.dev/](https://vite.dev/)\n- React\n  [https://react.dev/](https://react.dev/)\n- React Router\n  [https://reactrouter.com/](https://reactrouter.com/)\n- TanStack Query\n  [https://tanstack.com/query](https://tanstack.com/query)\n- Shadcn UI\n  [https://ui.shadcn.com/](https://ui.shadcn.com/)\n- React Hook Form\n  [https://react-hook-form.com/](https://react-hook-form.com/)\n- Zod\n  [https://zod.dev/](https://zod.dev/)\n- Tailwind CSS\n  [https://tailwindcss.com/](https://tailwindcss.com/)\n- Docker\n  [https://www.docker.com/](https://www.docker.com/)\n- GitHub Actions\n  [https://github.com/features/actions](https://github.com/features/actions)\n\n## Getting Started\n\n### Prerequisites\n\n- Halcyon API\n  [https://github.com/chrispoulter/halcyon-api](https://github.com/chrispoulter/halcyon-api)\n\n### Install dependencies\n\nInstall NPM packages:\n\n```\nnpm install\n```\n\n### Configure environment variables\n\nFor local development, you'll need to create a `.env.local` file in the root of the project to define the environment variables. This file is ignored by Git, so the secrets will not be committed to the repository.\n\n```\nVITE_API_URL=http://localhost:5257\n```\n\n### Running the development server\n\nOnce the dependencies are installed, you can run the development server:\n\n```\nnpm run dev\n```\n\nOpen http://localhost:5173 in your browser to see the project running.\n\n## Building for Production\n\nTo build the project for production:\n\n```\nnpm run build\n```\n\nThis command will create an optimized build in the `dist` folder.\n\n## Linting \u0026 Formatting\n\nTo lint and format the code:\n\n```\nnpm run lint\nnpm run format\n```\n\n## Contributing\n\nFeel free to submit issues or pull requests to improve the template. Ensure that you follow the coding standards and test your changes before submission.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispoulter%2Fhalcyon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrispoulter%2Fhalcyon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispoulter%2Fhalcyon/lists"}