Development
Setup
Note:
pnpmis the package manager of choice for developing this mono-repo.
macOS / Node >= 17 is the most tested environment. Please note that end-user can use anything recommended for a typical Astro project while using Astro Content distributables.
git clone git@github.com:JulianCataldo/astro-content.git
cd astro-content
pnpm -r i
# ———— Watch / build mono-repo. (turbo)
pnpm run dev
# ———— Doc. website (astro)
cd docs && pnpm run devPackages
| Role | Notes | Name | Artefact |
|---|---|---|---|
| Integration (Entrypoint) | Extends Astro / Vite capabilities | astro-content |  |
| Server | Data handlers, API provider, helpers generator | @astro-content/server |  |
| Command line | Project setups and content manipulation | @astro-content/cli | |
| Web app (Optional) | Full-fledge content editor / monitor | @astro-content/gui | |
| TypeScript typings | Internal types for development use | @astro-content/types | |
| Docs (Private) | Using and demonstrating all tools above | astro-content.netlify.app | |
| Demo (Clonable) | Minimal boilerplate | ./demo |
@astro-content/* are all internal dependencies of the main astro-content integration package, which act as a bridge for them.
Web GUI can be opted out by user settings.
Deployment environments
| Branch | Description | Deployment URL |
|---|---|---|
Feature (<feat_branch>) | Preview experiments or future additions in isolation. | [branch]--astro-content.netlify.app/__content |
Production (master) | Stable release. | astro-content.netlify.app/__content |
🆕 Next! (develop) | All future features. | develop--astro-content.netlify.app/__content |