Skip to content

Point the README at the docs site #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PianoNic merged 1 commit into from
Aug 12, 2026
Merged

Point the README at the docs site #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 26 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,42 @@
<p align="center">
<a href="https://github.com/schulydev/SchulyWebsite/stargazers"><img src="https://img.shields.io/github/stars/schulydev/SchulyWebsite?style=flat&color=3da8ff" alt="GitHub stars"/></a>
<a href="https://angular.dev/"><img src="https://img.shields.io/badge/Angular-20-3da8ff" alt="Angular"/></a>
<a href="https://docs.schuly.dev/SchulyWebsite/"><img src="https://img.shields.io/badge/docs-docs.schuly.dev-3da8ff" alt="Documentation"/></a>
<a href="https://schuly.dev"><img src="https://img.shields.io/badge/site-schuly.dev-3da8ff" alt="Website"/></a>
</p>

Angular-based marketing site for Schuly. Hosts the public landing page, app downloads, and project documentation.
Angular marketing site for Schuly. Hosts the public landing page and app downloads, in five languages with per-language prerendered URLs.

Project documentation lives at [docs.schuly.dev](https://docs.schuly.dev), not on this site.

## Quick start

```sh
bun install
bun start # ng serve on http://localhost:4200
bun run build # production build
```

## Documentation

Full documentation lives at **[docs.schuly.dev/SchulyWebsite](https://docs.schuly.dev/SchulyWebsite/)**.

| Guide | What it covers |
|---|---|
| [Development setup](https://docs.schuly.dev/SchulyWebsite/setup/development) | Prerequisites, install, run, watch, and tests. |
| [Deployment](https://docs.schuly.dev/SchulyWebsite/setup/deployment) | How the site is built and published. |
| [Release](https://docs.schuly.dev/SchulyWebsite/setup/release) | Cutting a release. |
| [Architecture](https://docs.schuly.dev/SchulyWebsite/architecture) | App structure, i18n, and prerendering. |
| [Contributing](https://docs.schuly.dev/SchulyWebsite/contributing) | Workflow, branch and PR conventions. |

## The Schuly ecosystem

| Repo | Purpose |
|---|---|
| [**Schuly**](https://github.com/schulydev/Schuly) | Flutter mobile app |
| [**SchulyBackend**](https://github.com/schulydev/SchulyBackend) | ASP.NET Core API backend |
| [**SchulyKeycloak**](https://github.com/schulydev/SchulyKeycloak) | Keycloak image + the `schuly` realm |
| [**SchulyPluginAbstractions**](https://github.com/schulydev/SchulyPluginAbstractions) | Plugin contract (NuGet) |
| [**SchulyPlugins**](https://github.com/schulydev/SchulyPlugins) | Official plugins monorepo |
| [**SchulyWebsite**](https://github.com/schulydev/SchulyWebsite) | Landing site ([schuly.dev](https://schuly.dev)) *(this repo)* |

## Run

```sh
bun install
bun start # ng serve on http://localhost:4200
```

## Build

```sh
bun run build
```
| [**SchulyDocs**](https://github.com/schulydev/SchulyDocs) | Documentation site ([docs.schuly.dev](https://docs.schuly.dev)) |