README

quick-crud

Laravel CRUD 操作的样板。

开始使用

为了使您更容易开始使用 GitLab，这里有一份推荐步骤列表。

已经是专家了吗？只需编辑这个 README.md，让它成为您自己的。想让它变得简单？使用下面的模板！

添加您的文件

[ ] [创建](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的 Git 仓库

cd existing_repo
git remote add origin https://gitlab.com/shrestha-niranjan/quick-crud.git
git branch -M main
git push -uf origin main

集成您的工具

[ ] [设置项目集成](https://gitlab.com/shrestha-niranjan/quick-crud/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建一个新的合并请求](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭来自合并请求的问题](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求审批](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [管道成功时自动合并](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用 GitLab 内置的持续集成。

[ ] [开始使用 GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用程序部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉取的部署以改进 Kubernetes 管理](https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此 README

当您准备好将此 README 纳为己有时，只需编辑此文件并使用下面的便捷模板（或者您可以自由地按自己的方式结构化它 - 这只是一个起点！）感谢 makeareadme.com 提供此模板。

良好的 README 建议

每个项目都不同，因此请考虑哪些部分适用于您的项目。模板中使用的部分是针对大多数开源项目的建议。同时请注意，虽然README可能过长且详细，但过长总比过短好。如果您认为您的README过长，请考虑利用另一种形式的文档，而不是删除信息。

名称

为您的项目选择一个易于理解的名称。

描述

让人们知道您的项目具体能做什么。提供上下文并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果有替代您的项目的项目，这里列出不同的因素是一个好主意。

徽章

在某些README中，您可能会看到一些小图像，传达元数据，例如项目是否所有测试都通过。您可以使用盾牌在README中添加一些。许多服务也有添加徽章的说明。

视觉

根据您正在制作的内容，包含截图甚至视频（您经常会看到GIF而不是实际的视频）可能是个好主意。ttygif等工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

在特定的生态系统内，可能存在一种常见的安装方式，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一位新手，并希望获得更多指导。列出具体步骤有助于消除歧义，并尽快让人们使用您的项目。如果它只在特定的上下文中运行，例如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也可以添加一个“需求”子部分。

用法

广泛使用示例，并显示您能提供的预期输出。如果有太长而无法合理包含在README中的更复杂示例，提供链接是有帮助的。

支持

告诉人们他们可以到哪里寻求帮助。可以是问题跟踪器、聊天室、电子邮件地址等的任何组合。

路线图

如果您对未来发布的想法，将其列在README中是个好主意。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

对于想要修改您项目的人来说，有关如何开始的一些文档是有帮助的。也许他们应该运行一个脚本来设置一些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少更改意外破坏事物的可能性。如果需要外部设置，例如启动Selenium服务器进行浏览器测试，运行测试的说明特别有用。

作者和致谢

向为项目做出贡献的人表示感谢。

许可证

对于开源项目，说明其许可证。

项目状态

如果您已耗尽为项目提供能量或时间，请在README的顶部注明开发已放缓或已完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，使您的项目得以继续。您还可以明确请求维护者。

najnarin / quick-crud

维护者

详情