From 7c721465e20d87452311ee3c8daae9ad39ac5936 Mon Sep 17 00:00:00 2001 From: Jasonzyt <66063199+Jasonzyt@users.noreply.github.com> Date: Sun, 12 Jan 2025 20:44:20 +0800 Subject: [PATCH] chore: add license and readme --- LICENSE | 21 +++++++++++++++ README.md | 77 ++++++++++--------------------------------------------- 2 files changed, 34 insertions(+), 64 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ba59d79 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Jasonzyt + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 25b5821..94da178 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,24 @@ -# Nuxt Minimal Starter +# Campu-site -Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. +Campu is a blog framework based on Nuxt. -## Setup +It's @Jasonzyt's first web frontend project. -Make sure to install dependencies: +Still under construction. -```bash -# npm -npm install - -# pnpm -pnpm install - -# yarn -yarn install - -# bun -bun install -``` - -## Development Server - -Start the development server on `http://localhost:3000`: - -```bash -# npm -npm run dev - -# pnpm -pnpm dev - -# yarn -yarn dev - -# bun -bun run dev +## Build + ``` - -## Production - -Build the application for production: - -```bash -# npm -npm run build - -# pnpm -pnpm build - -# yarn -yarn build - -# bun -bun run build +pnpm install +pnpm run build ``` -Locally preview production build: +## Deploy -```bash -# npm -npm run preview +[./.github/workflows/deploy.yml](./.github/workflows/deploy.yml) provided a way to deploy the site to your own server. -# pnpm -pnpm preview +Since the static support with Nuxt Content is under development, GitHub Pages deployment is not supported at the moment. (see [nuxt/content#1229](https://github.com/nuxt/content/issues/1229)) -# yarn -yarn preview - -# bun -bun run preview -``` +## License -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. +MIT \ No newline at end of file