Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nermalcat69/zerops-starlight
:herb: Starlight Deployment on Zerops
https://github.com/nermalcat69/zerops-starlight
astro astro-template astro-zerops deploy deployment starlight-astro starlight-zerops zerops zerops-deployment
Last synced: about 2 months ago
JSON representation
:herb: Starlight Deployment on Zerops
- Host: GitHub
- URL: https://github.com/nermalcat69/zerops-starlight
- Owner: nermalcat69
- Created: 2024-05-24T05:57:51.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T02:34:09.000Z (about 2 months ago)
- Last Synced: 2024-12-12T03:20:49.665Z (about 2 months ago)
- Topics: astro, astro-template, astro-zerops, deploy, deployment, starlight-astro, starlight-zerops, zerops, zerops-deployment
- Language: MDX
- Homepage: https://starlight.zerops.xyz
- Size: 187 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://starlight.astro.build)
# Starlight on Zerops - SSG
This is a template for deploying Astro's Starlight docs (SSG) to Zerops, along with a guide on how to deploy to Zerops using both their GUI and CLI.
## Import Project to Zerops
```yml
project:
name: astro
services:
- hostname: app
type: static
enableSubdomainAccess: true
buildFromGit: https://github.com/nermalcat69/zerops-starlight
```
## 🚀 Project Structure
Inside of your Astro + Starlight + Zerops project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
└── zerops.yml
```
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the `public/` directory.
`zerops.yml` used for deploying to zerops via cli or gui.
## Deploying Using Zerops Gui - [Go to Zerops Dashboard](https://app.zerops.io)
### Importing in a new project
```yaml
# You can remove the project parameter if you're importing
# a service into an existing project instead of creating a
# new one
project:
name: zerops-nextjs
services:
- hostname: starlight
type: [email protected]
nginxConfig: |-
server {
listen 80 default_server;
listen [::]:80 default_server;
server_name _;
root /var/www;
location / {
try_files $uri $uri/ /index.html;
}
access_log syslog:server=unix:/dev/log,facility=local1 default_short;
error_log syslog:server=unix:/dev/log,facility=local1;
}
buildFromGit: https://github.com/nermalcat69/zerops-starlight-ssg
enableSubdomainAccess: true
minContainers: 1
```
> 🧑🚀 **Confused about how to import?** Watch this video about how to import and setup a new project https://youtu.be/ZahXCIaUr_A !
> To import into an existing project just go to the existing project and check the left sidebar to import a service(make sure that the project parameter in import yaml).
## Deploying Using Zerops Cli - [@zeropsio/zcli](https://github.com/zeropsio/zcli)
### Setting up the Project Locally
```bash
git clone https://github.com/nermalcat69/zerops-starlight
```
```bash
pnpm install
```
```bash
pnpm run build
```
### Setting up Zerops yaml
```bash
zerops:
- setup: starlight # Service hostname
build:
base: nodejs@18 # Technology used to build the app
buildCommands: # Build commands
- pnpm i
- pnpm run build
deploy: # Build artifacts deployed to the runtime
- dist/~
cache: # Cache for faster next round of build
- node_modules
- pnpm-lock.yaml
```
Follow these commands to deploy a project to zerops.
| Command | Action |
| :------------------- | :----------------------------------------------------------------------------------------------- |
| `zcli login ` | Command to login to your zerops account using your [token](https://app.zerops.io/settings/token-management). |
| `zcli push` | Command to push your codebase to a service (you need to have zerops.yml in your root directory). |
## 👨💻 Facing Issues while deploying?
If you still find yourself stuck in the process join [Zerops Discord Server](https://discord.gg/5ptAqtpyvh) or Checkout [Zerops Docs](https://docs.zerops.io).
## 👀 Want to learn more about Starlight?
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).