{"id":13603181,"url":"https://github.com/kirklin/celeris-web","last_synced_at":"2025-10-05T15:38:08.203Z","repository":{"id":113024104,"uuid":"590477488","full_name":"kirklin/celeris-web","owner":"kirklin","description":"Celeris Web is a highly performant and customizable front-end development template built with Vue 3, Vite, and TypeScript. It features the latest syntax, components and APIs auto importing, state management, Chinese font presets, internationalization, and integration with OpenAI's ChatGPT API.","archived":false,"fork":false,"pushed_at":"2025-01-09T16:30:23.000Z","size":3892,"stargazers_count":450,"open_issues_count":11,"forks_count":62,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-31T00:13:07.448Z","etag":null,"topics":["admin","admin-dashboard","chatgpt","i18n","naive-ui","typescript","vite","vue"],"latest_commit_sha":null,"homepage":"https://celeris-web.vercel.app/","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/kirklin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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},"funding":{"github":"kirklin","patreon":"kirklin","custom":["https://www.buymeacoffee.com/linkirk"]}},"created_at":"2023-01-18T14:06:43.000Z","updated_at":"2025-03-28T10:12:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"f925d0a2-0da0-4996-9fec-050961283f0a","html_url":"https://github.com/kirklin/celeris-web","commit_stats":{"total_commits":457,"total_committers":5,"mean_commits":91.4,"dds":0.01094091903719907,"last_synced_commit":"fc3acfeb4c4f9589fcb9cc4c9500de30bc1a1642"},"previous_names":["kirklin/celeris-web","kirklin/celeris-admin"],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirklin%2Fceleris-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirklin%2Fceleris-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirklin%2Fceleris-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirklin%2Fceleris-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kirklin","download_url":"https://codeload.github.com/kirklin/celeris-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247574087,"owners_count":20960496,"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":["admin","admin-dashboard","chatgpt","i18n","naive-ui","typescript","vite","vue"],"created_at":"2024-08-01T18:01:55.816Z","updated_at":"2025-10-05T15:38:08.197Z","avatar_url":"https://github.com/kirklin.png","language":"TypeScript","funding_links":["https://github.com/sponsors/kirklin","https://patreon.com/kirklin","https://www.buymeacoffee.com/linkirk"],"categories":["Openai","chatgpt","Open-Source Projects","Get Started"],"sub_categories":["Templates"],"readme":"\u003cdiv align='center'\u003e\n\u003cimg src='docs/README.assets/logo.svg' alt='celeris-web - free and open-source front-end development framework' width='256'/\u003e\n\u003ch1\u003eCeleris Web\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align='center'\u003e\n\u003cb\u003eEnglish\u003c/b\u003e | \u003ca href=\"README.zh-CN.md\"\u003e简体中文\u003c/a\u003e\n\u003c/div\u003e\n\n## Introduction\n\nCeleris Web is a free and open-source front-end development framework that utilizes the latest technologies, including Vue 3, Vite, and TypeScript. Its monorepo approach makes it easy to manage dependencies and collaborate on multiple projects, providing developers with a comprehensive solution for building modern web applications.\n\nWhether you're a seasoned developer or just starting out, Celeris Web offers a streamlined front-end development process that leverages the latest tools and techniques.\n\nGet started with celeris-web today and experience a highly streamlined front-end development process that harnesses the power of the latest technologies, including cutting-edge natural language processing capabilities.\n\n## Documentation\n\n📚 **For comprehensive documentation and guides, visit our [DeepWiki documentation](https://deepwiki.com/kirklin/celeris-web).**\n\n## Features\n\n- ⚡ [Lightning fast](https://github.com/kirklin/celeris-web#readme): Built with Vue 3, Vite, and pnpm 🔥\n- 💪 [Strongly typed](https://www.typescriptlang.org/): Uses TypeScript 💻\n- 📂 [Monorepo approach](https://en.wikipedia.org/wiki/Monorepo): Makes it easy to manage dependencies and collaborate on multiple projects 🤝\n- 🔥 [Latest syntax](https://github.com/vuejs/rfcs/pull/227): Uses the new \u003cscript setup\u003e syntax 🆕\n- 📦 [Components auto importing](https://github.com/kirklin/celeris-web/blob/master/packages/shared/vite/src/plugins/unpluginVueComponets.ts): Automatically imports components 🚚\n- 📥 [APIs auto importing](https://github.com/kirklin/celeris-web/blob/master/packages/shared/vite/src/plugins/unpluginAutoImport.ts): Uses unplugin-auto-import to directly import Composition API and others 📨\n- 💡 [Official router](https://router.vuejs.org/): Uses Vue Router v4 🛣️\n- 🎉 [Loading feedback](https://github.com/rstacruz/nprogress): Uses NProgress to provide page loading progress feedback 🔄\n- 🍍 [State management](https://pinia.esm.dev/): Uses Pinia for state management 🗃️\n- 📜 [Chinese font preset](https://github.com/kirklin/unocss-preset-chinese): Includes a preset for Chinese fonts 🇨🇳\n- 🌍 [I18n ready](https://github.com/kirklin/celeris-web/tree/master/packages/web/locale): Ready for internationalization with locales 🌎\n- ☁️ [Netlify ready](https://www.netlify.com/): Zero-config deployment on Netlify ☁️\n\n### Coding Style\n\n- [@kirklin/eslint-config](https://github.com/kirklin/eslint-config)\n\n### Recommended IDE Setup\n\n- 🌪️ [WebStorm](https://www.jetbrains.com/webstorm/)\n- 💻 [VSCode](https://code.visualstudio.com/)\n- 💡 [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)\n\n### [packages](packages) dependency relationship\n\n```mermaid\n graph TD\n   admin{admin}\n   admin --\u003e admin-api\n   admin --\u003e assets\n   admin --\u003e ca-components\n   admin --\u003e components\n   admin --\u003e constants\n   admin --\u003e directives\n   admin --\u003e hooks\n   admin --\u003e locale\n   admin --\u003e request\n   admin --\u003e styles\n   admin --\u003e types\n   admin --\u003e utils\n   assets\n   components\n   components --\u003e assets\n   components --\u003e ca-components\n   components --\u003e constants\n   components --\u003e styles\n   components --\u003e types\n   components --\u003e utils\n   ca-components\n   ca-components --\u003e constants\n   ca-components --\u003e utils\n   directives\n   directives --\u003e utils\n   hooks\n   hooks --\u003e types\n   locale\n   locale --\u003e constants\n   locale --\u003e types\n   locale --\u003e utils\n   request\n   request --\u003e constants\n   request --\u003e locale\n   request --\u003e types\n   request --\u003e utils\n   types\n   types --\u003e constants\n   utils\n   utils --\u003e types\n   admin-api\n   admin-api --\u003e constants\n   admin-api --\u003e types\n\n```\n\nTo update the diagram above edit the README file and open a new PR with the changes.\n\n## Bilingual Comments in Code\n\nIn the design of Celeris Web, we emphasize the readability and learnability of the code. To achieve this, each function is equipped with bilingual comments in both Chinese and English, ensuring that developers, regardless of their native language, can easily understand and learn from the code.\n\n**Why Choose Bilingual Comments?**\n\n1. **Global Collaboration:** In multicultural teams, bilingual comments foster better communication and collaboration, ensuring that team members can accurately comprehend the functionality and implementation of the code.\n\n2. **Convenient Learning:** For beginners, bilingual comments provide a more user-friendly learning environment, aiding them in quickly grasping the logic and structure of the code.\n\n3. **Developer-Friendly:** We are committed to creating a developer-friendly environment, and bilingual comments are a crucial measure we've taken to achieve this goal.\n\n**Example:**\n\n```typescript\n/**\n * 打开一个新的浏览器窗口\n * Open a new browser window\n *\n * @param {string} url - 要在新窗口中打开的 URL\n * The URL to open in the new window\n *\n * @param {object} options - 打开窗口的选项\n * Options for opening the window\n * @param {string} options.target - 新窗口的名称或特殊选项，默认为 \"_blank\"\n * @param {string} options.features - 新窗口的特性（大小，位置等），默认为 \"noopener=yes,noreferrer=yes\"\n */\nexport function openWindow(url: string, { target = \"_blank\", features = \"noopener=yes,noreferrer=yes\" }: {\n  target?: \"_blank\" | \"_self\" | \"_parent\" | \"_top\"; // 新窗口的名称或特殊选项，默认为 \"_blank\"\n  features?: string; // 新窗口的特性（大小，位置等），默认为 \"noopener=yes,noreferrer=yes\"\n} = {}) {\n  window.open(url, target, features);\n}\n```\n\nThrough these bilingual comments, we aim to provide developers with a more enjoyable and efficient coding experience, making Celeris Web a frontend template that is truly easy to pick up and dive into.\n\n## Benefits of Monorepo Design\n\n**1. Easier Dependency Management:** Monorepo centralizes the management of dependencies for all projects, avoiding version conflicts between different projects and making overall dependency management clearer and simpler.\n\n**2. Code Sharing and Reusability:** Different projects can easily share and reuse code, reducing the workload of redundant development. This is highly beneficial for maintaining code consistency and improving development efficiency.\n\n**3. Unified Build and Deployment:** Monorepo simplifies the entire development process through a unified build and deployment workflow, reducing the complexity of configuration and management and enhancing collaboration efficiency within the development team.\n\n**4. Unified Version Control:** With all projects in the same version control repository, version management becomes more consistent and controllable. This helps the team better track and handle version-related issues. The Monorepo design positions Celeris Web not only as an admin system template but also as a frontend web template for rapidly developing C-end products. With Celeris Web, the journey of frontend development becomes even more relaxed and enjoyable! 🚀\n\n## Design Philosophy: Breaking the Limits of Admin Management, Focusing on C-End User Experience\n\nIn the market, most frontend templates primarily cater to the needs of B-end users, providing powerful features and flexible interfaces for enterprise management systems (Admin). However, few templates consider the characteristics of C-end products in their design, and this is where Celeris Web innovates.\n\n**Breaking the Limits of Admin Management:**\n\nTraditional Admin management systems prioritize data display and business management, while C-end products emphasize user experience and visual appeal. Recognizing C-end users' demands for aesthetically pleasing interfaces and smooth interactions, Celeris Web not only offers robust backend management features but also focuses on elevating the frontend interface to a higher level of user satisfaction.\n\n**Focusing on C-End User Experience:**\n\nCeleris Web is not just a template for admin systems; it's a frontend web template that prioritizes the user experience for C-end products. We aim to break free from the constraints of traditional Admin systems by introducing innovative design principles, ensuring that C-end products presented on the frontend deliver an outstanding user experience.\n\n**Highlighted Features:**\n\n- **Stylish and Aesthetic UI Design:** We prioritize visual aesthetics, utilizing modern design languages to make Celeris Web's UI not just a compilation of features but a visual feast that captivates C-end users.\n- **User-Friendly Interaction Experience:** Considering the habits and needs of C-end users, Celeris Web emphasizes interactive design. Through smooth animation effects and intuitive operations, users can experience unprecedented pleasure and convenience.\n- **Customizable Themes for Personalization:** Recognizing the diversity of C-end products, we provide a rich set of theme customization options, allowing each C-end project to have a unique appearance that perfectly aligns with personalized requirements.\n\nWith this unique design philosophy, Celeris Web strives to explore new possibilities in frontend development, injecting more vitality and creativity into C-end products. We believe that such innovation will garner widespread user recognition and contribute to higher product value. In the world of Celeris Web, frontend development transcends the confines of Admin systems, incorporating more exciting elements related to user experience.\n\n## Try it now!\n\n### GitHub Template\n\n[Create a repo from this template on GitHub](https://github.com/kirklin/celeris-web/generate).\n\n### Clone to local\n\n```bash\nnpx degit kirklin/celeris-web my-vite-app\ncd my-vite-app\npnpm i\n```\n\n## Usage\n\n### Development\n\nJust run and visit http://localhost:8888\n\n```bash\npnpm run dev\n```\n\n### Build\n\nTo build the App, run\n\n```bash\npnpm run build\n```\n\nAnd you will see the generated file in `dist` that ready to be served.\n\n### Deploy on Netlify\n\nGo to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.\n\n### Docker Production Build\n\nFirst, build the celeris-web image by opening the terminal in the project's root directory.\n\n```bash\ndocker buildx build . -t celeris-web:latest\n```\n\nRun the image and specify port mapping with the `-p` flag.\n\n```bash\ndocker run --rm -it -p 8080:80 celeris-web:latest\n```\n\n## Star History\n\n\u003ca href=\"https://star-history.com/#kirklin/celeris-web\u0026Date\"\u003e\n \u003cpicture\u003e\n   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=kirklin/celeris-web\u0026type=Date\u0026theme=dark\" /\u003e\n   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=kirklin/celeris-web\u0026type=Date\" /\u003e\n   \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=kirklin/celeris-web\u0026type=Date\" /\u003e\n \u003c/picture\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirklin%2Fceleris-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirklin%2Fceleris-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirklin%2Fceleris-web/lists"}