{"id":28178428,"url":"https://github.com/mirasaki-development/dayz-community-template","last_synced_at":"2025-05-16T01:14:00.910Z","repository":{"id":229694121,"uuid":"776748703","full_name":"Mirasaki-Development/dayz-community-template","owner":"Mirasaki-Development","description":"Customizable website/landing page for DayZ communities","archived":false,"fork":false,"pushed_at":"2025-03-04T12:50:04.000Z","size":2944,"stargazers_count":7,"open_issues_count":0,"forks_count":18,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T13:42:04.516Z","etag":null,"topics":["cftools","dayz","docker","docker-compose","leaderboard","nextjs","tailwindcss","template","website","website-template"],"latest_commit_sha":null,"homepage":"https://template-1.mirasaki.dev","language":"TypeScript","has_issues":true,"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/Mirasaki-Development.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-03-24T11:37:06.000Z","updated_at":"2025-03-04T12:50:07.000Z","dependencies_parsed_at":"2024-04-22T20:29:17.816Z","dependency_job_id":"54c64d3a-aa2e-446f-a243-f15f8692bbba","html_url":"https://github.com/Mirasaki-Development/dayz-community-template","commit_stats":null,"previous_names":["mirasaki-development/dayz-community-template"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirasaki-Development%2Fdayz-community-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirasaki-Development%2Fdayz-community-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirasaki-Development%2Fdayz-community-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirasaki-Development%2Fdayz-community-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mirasaki-Development","download_url":"https://codeload.github.com/Mirasaki-Development/dayz-community-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254448572,"owners_count":22072765,"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":["cftools","dayz","docker","docker-compose","leaderboard","nextjs","tailwindcss","template","website","website-template"],"created_at":"2025-05-16T01:12:23.844Z","updated_at":"2025-05-16T01:14:00.903Z","avatar_url":"https://github.com/Mirasaki-Development.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DayZ Community Template\n\nThis is an easy to customize, forever-free template to bring an online presence to your (DayZ) gaming community. While initially intended to be used for DayZ communities, all DayZ specific elements can be easily disabled - making this template ideal for any gaming community.\n\n\u003e 😎 Have any questions or just want to chill/have a chat? Come join our [support server](https://discord.gg/mirasaki).\n\n## ✨ Demo\n\nA demo deployment showcasing this project can be found [here](https://template-1.mirasaki.dev/).\n\n![Preview image](/public/images/marketing/banner.png \"Preview\")\n\n## 🚀 Deploy on Vercel\n\nThe easiest way to deploy this Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme) from the creators of Next.js.\n\nCheck out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMirasaki-Development%2Fdayz-community-template\u0026env=STEAM_API_KEY,CFTOOLS_API_APPLICATION_ID,CFTOOLS_API_SECRET\u0026envDescription=Credentials%20required%20for%20the%20application.\u0026envLink=https%3A%2F%2Fgithub.com%2FMirasaki-Development%2Fdayz-community-template%3Ftab%3Dreadme-ov-file%23environmental-values\u0026project-name=my-dayz-website\u0026repository-name=my-dayz-website\u0026demo-title=%5BDemo%5D%20DayZ%20Community%20Website\u0026demo-description=An%20easy%20to%20customize%2C%20forever-free%20template%20to%20bring%20an%20online%20presence%20to%20your%20(DayZ)%20gaming%20community.\u0026demo-url=https%3A%2F%2Ftemplate-1.mirasaki.dev%2F\u0026demo-image=https%3A%2F%2Fraw.githubusercontent.com%2FMirasaki-Development%2Fdayz-community-template%2Fmain%2Fpublic%2Fimages%2Fmarketing%2Fbanner.png)\n\n## 📦 Installation (Docker, recommended)\n\nWe recommend [Docker (Desktop)](https://www.docker.com/products/docker-desktop/) for any modern application, as it accelerates the build \u0026 run process and standardizes environments.\n\n1. Download and extract [the latest release](https://github.com/Mirasaki-Development/dayz-community-template/releases) and navigate into the newly created folder.\n2. Rename `/.env.example` to `/.env.local` (make sure [file extensions are enabled](https://www.youtube.com/watch?v=z5FBLAagPIc) if you're on Windows) and fill in your configuration.\n3. Open `/config.ts` and customize to your hearts content.\n4. Run the following commands in this exact order:\n\n```sh\n# Build the project\ndocker compose build\n\n# Start the project\ndocker compose up -d\n```\n\nThe project is now available on [port 13001](http://localhost:13001/). This is (by default) only available locally through a Docker network bridge, and you should be able to add a web-server to the `docker-compose.yml` file [fairly easily](https://hub.docker.com/_/nginx/) if desired.\n\n## 🔨 Installation (Local, alternative)\n\n1. Install [Node.js](https://nodejs.org/en/download).\n2. Install [PNpm](https://pnpm.io/installation) on your machine.\n    - Windows: `iwr https://get.pnpm.io/install.ps1 -useb | iex`\n    - POSIX systems: `curl -fsSL https://get.pnpm.io/install.sh | sh -`\n    - POSIX w/o CURL: `wget -qO- https://get.pnpm.io/install.sh | sh -`\n3. Download and extract [the latest release](https://github.com/Mirasaki-Development/dayz-community-template/releases) and navigate into the newly created folder. (Don't install the project in the `Desktop` directory if you're on Windows due to permissions)\n4. Rename `/.env.example` to `/.env.local` (make sure [file extensions are enabled](https://www.youtube.com/watch?v=z5FBLAagPIc) if you're on Windows) and fill in your configuration.\n5. Open `/config.ts` and customize to your hearts content.\n6. Run the following commands in this exact order:\n\n```sh\n# Install dependencies\npnpm install\n\n# Build the project\npnpm build\n\n# Start the project\npnpm start\n```\n\nThe project is now available on [port 3000](http://localhost:3000/). This is only available on your local network.\n\n## ⚙️ Configuration\n\nThe bulk of the configuration is done in the `/config.ts` file. This is a Typescript file, meaning the syntax for this configuration object is very similar to JSON. All keys are meant to be self-explanatory, if you need additional information - head on over to the `/src/lib/config.types.ts` file for explanations.\n\n### Environmental Values\n\nThis section documents the values defined in the `/.env.local` file.\n\n\u003e When configuring the CFTools Developer Application, you are required to [grant access to resources](https://wiki.mirasaki.dev/docs/cftools-create-application#grant-access-to-resources).\n\n```bash\n# Your Steam API key can be obtained here: https://steamcommunity.com/dev/apikey\n# The domain on the page linked above doesn't have to match\n# This is used to fetch your dayz server information\nSTEAM_API_KEY=\n\n# CFTools Developer Application\n# Values can be grabbed from https://developer.cftools.cloud/applications\n# Please refer to the documentation if you're unsure: https://wiki.mirasaki.dev/docs/cftools-create-application\n# This is used to fetch the leaderboard information\nCFTOOLS_API_APPLICATION_ID=\nCFTOOLS_API_SECRET=\n```\n\n### Static Files\n\nStatic files/assets are served from the `/public` directory. Whenever an image (or other type of local file) is used in the configuration, it's value (the path) is relative to this root `public` directory. That means `/images/logo.png` in the configuration file points to `/public/images/logo.png`.\n\n### CSS and styling\n\nAlthough simple styling configuration is done in the `/config.ts` file, theme customization can be performed in `/src/app/globals.css`. These are space-separated HSL values.\n\nYou can use [this website](https://atmos.style/color-picker/hsl) to obtain your HSL values. Do note, `hsl(184.4, 95%, 60.8%)` format is incorrect, use `184.4 95% 60.8%` instead.\n\n### Favicon (and other metadata files)\n\nThe favicon (browser tab/bookmark icon for pages) can be customized by replacing the source files in `/src/app/favicon.ico`. You can generate these source files from your logo/icon [on this site](https://favicon.io/favicon-converter/). Simply upload your logo/icon and click \"Download\". **Remember** to update the `apple-touch-icon` and `favicon-16x16` images in `/public` as well!\n\nFor more information on metadata files in Next.JS, check out the [developer reference](https://nextjs.org/docs/app/api-reference/file-conventions/metadata).\n\n### Web Server\n\nAfter you've set-up and configured the website, it will only be available on your local network. To allow anyone to reach your website, basic knowledge of web-servers (like [Apache](https://apache.org/) or [Nginx](https://nginx.org/en/)) is required.\n\n- An example Nginx file is included for your convenience [here](/examples/nginx.example.conf).\n- This configuration serves all static assets, if these fail to load (like no styles applied to the website) use the [minimal conf instead](/examples/nginx.min.conf).\n\nWeb host providers (like [Vykix](https://portal.vykix.com/aff.php?aff=17)) usually provide this functionality for you. When looking for a host, make sure they support `Node.js` and/or `Next.js` and you'll be able to get started - there's no additional dependencies.\n\n### CFTools Leaderboard\n\nThe [CFTools](https://cftools.com/) leaderboard can be disabled at any time. You can find your required `/.env.local` values by following [our guide](https://wiki.mirasaki.dev/docs/cftools-create-application). Please note the leaderboard endpoint requires an active CFTools subscription.\n\n## 🛠️ Development\n\nThe following stack and tools are used for this template:\n\n- [PNpm](https://pnpm.io/) - For package management and faster installation of dependencies.\n- [Turborepo](https://turbo.build/repo) - For significantly faster build times.\n- [NextJS](https://nextjs.org/) - For building fast, scalable React applications with built-in SSR, SSG, and routing capabilities.\n- [Flowbite](https://flowbite.com) - For production-ready Tailwind `blocks` and `components` (developer license).\n- [shadcn/ui](https://ui.shadcn.com/) - For quickly building your own component library.\n- [TailwindCSS](https://tailwindcss.com/) - For rapidly building custom user interfaces using utility-first CSS classes.\n- [Framer Motion](https://www.framer.com/motion/) - For creating fluid animations and interactive UI elements in React applications.\n- [Lucide React](https://lucide.dev/guide/packages/lucide-react) - For adding SVG icons and illustrations to React projects with ease.\n\n## ❗ Common Issues\n\n### ERR_ABORTED\n\nIf you're getting `net::ERR_ABORTED 404` errors, that means you have created a new production build but the process listening on your port is still trying to serve previous build files - fix this by restarting your process.\n\n## 👤 Author\n\n### Richard Hillebrand (Mirasaki)\n\n- Website: [https://mirasaki.dev/](https://mirasaki.dev/)\n- Github: [@Mirasaki](https://github.com/Mirasaki)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!\n\nFeel free to check out the [issues page](https://github.com/Mirasaki-Development/dayz-community-template/issues).\n\n## 🤩 Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 Licensing\n\nThis project is MIT licensed, meaning you're in full control.\n\n### Flowbite\n\n[Flowbite](https://flowbite.com) was used for some of the components in this template. Please note, if you want to add any other flowbite components, you **will need** your own license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirasaki-development%2Fdayz-community-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirasaki-development%2Fdayz-community-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirasaki-development%2Fdayz-community-template/lists"}