Skip to content

Commit

Permalink
chore: add license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jasonzyt committed Jan 12, 2025
1 parent c7ccf15 commit 7c72146
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 64 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
77 changes: 13 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 7c72146

Please sign in to comment.