/SveltyCMS

Primary LanguageSvelteMIT LicenseMIT

SveltyCMS logo

SveltyCMS

(Still in Development - Support always Appreciated!!)

Latest SemVer) GitHub issues

Sveltekit Badge TypeScript Badge Mongodb Badge Tailwindcss Badge

CodeQL Playwright Tests Auto Release

A powerful Headless CMS with Sveltekit Power

It's lightning fast, flexible and an easy to use modern content management system to provide a headless backend

This Sveltekit CMS provides a backend based on a modern SvelteKit 2 framework with a fast MongoDB for document database scalability and flexibility.

New Collections can easily be implemented, due to full typescript support with already many available widgets. we offer two ways to use it, via code or via GUI.

All fields offer full translation, and customization as well as access restriction.

The System language uses Paraglide JS a light weight JavaScript i18n library. 🇬🇧 English is our default and we offer multiple languages out of the box. More Languages can easily be extended to support further languages.

We used tailwindcss and a skeleton UI toolkit, so the CMS can be quickly optimized to your personal needs.

The Backend Data is provided via GraphQL Yoga, to build extremely fast frontends.

SveltyCMS Gui

🧰 SveltyCMS & DXP: Your Gateway to Streamlined Digital Experiences

Leverage the power of SveltyCMS along with the capabilities of Developer Experience Platform (DXP). This potent combination redefines content development, making it agile, efficient and optimized.

When DXP integrates into our CMS, it presents a suite of advanced tools, offering developers the freedom and adaptability for content creation and management. The result is a streamlined workflow and a quicker process of crafting superior quality content.

Experience a leap in productivity with DXP seamlessly woven into SveltyCMS. Watch it automate routine tasks, provide clear interfaces and simplify CMS management. Developers can now channel their focus on core tasks - creating premium content and applications.

Footnote: As a headless CMS fortified with GraphQL API, SveltyCMS fully harnesses the potential of DXP, driving functions, ensuring scalability, enhancing adaptability and delivering personalized digital experiences. Empower your development voyage today with the versatile capabilities of SveltyCMS integrated with DXP.

🚀 Setup

Clone the repository

To clone our repository you need to be able to use Git.

git clone https://github.com/Rar9/SveltyCMS.git

cd SveltyCMS

Install all dependencies

Install Node.js to get started which ships with npm.

We recommend the faster pnpm package manager. Yarn and the bun.sh can also be used as well. Adapt the command accordingly.

npm install   # installs all required package dependencies

Setup Environment Variables

This project uses a public/private configuration to store sensitive information, such as API keys and database passwords.

To set up the project, you will need to create two files in the project root directory:

The config folder contains two example configuration files that you can rename to get started. Typescript helps you with code completion.

Create config/private.ts and config/public.ts

mv config/example.private.ts config/private.ts
mv config/example.public.ts config/public.ts

The config/private.ts contain sensitive information that you do not want to expose to the public. This includes things like: Database & Email configs, API keys, Secret tokens.

The config/public.ts contains configuration settings that are safe to share with the public, This includes things like: Site name, Language handling, Media configurations.

Start the application for development or production

See our package.json for more information like development, build, preview, format, lint & testing. Here the most used commands:

npm run dev       # run development on localhost:5173
npm run build     # build for production
npm run preview   # to run preview on localhost:4173

🔒 Authentication & Security

We want to keep your data Private and Secure.

Our Authentication allows us to stay flexible for the future and adapt to changing security needs.

You can sign by email and password or use google oauth.

Field-based content access enables the allocation of varying levels of access to users according to their roles and permissions. This way, you can control who can view, edit, or delete your data.

🎨 Easy Theme Adaptions to your needs

If you require a different look, use the skeleton theme generator and modify the SveltyCMSTheme.ts to your needs

🌍 Great System Localization i18n infrastructure

We use Paraglide JS, the best i18n library together with inlang ecosystem for first class System Translations with full typescript support.

Our System Translations are available at: inlang and can easily be extended.

If a language has not yet been defined, reach out to us, so that you can help extend the System Localization.

inlang status badge

📋 Easily create Data Collections

Great Experience to designing user-friendly and intuitive interfaces for managing content. Full Typescript support to display all available widgets, options to create fully custom data structures.

📨 Flexible Email Templating System

Build and send emails using Svelty Email and TypeScript.

❓ Need help

Contact us if you're struggling installation or other issues via: GitHub Discussions

🚀 Semantic Versioning

We use semantic versioning to manage our releases. This means that our version numbers follow a specific format: MAJOR.MINOR.PATCH.

  • MAJOR version changes when we make incompatible API changes,
  • MINOR version changes when we add functionality in a backwards-compatible manner, and
  • PATCH version changes when we make backwards-compatible bug fixes.

When submitting pull requests, please make sure your commit messages follow the Conventional Commits specification. This will help us automatically generate changelogs and release notes.

Please also read our Code of Conduct before submitting Pull Requests.

If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch.

Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Please prefix changeset messages with feat:, fix:, or chore:.

Thank you for helping us maintain a consistent and predictable release process! ❤️

Contributing

We welcome all kinds of contributions! Please see our CONTRIBUTING.md for details on how to get started with this.

💰 Sponsoring

If you find our project useful and would like to support its development, you can become a sponsor! Your sponsorship will help us cover the costs of maintaining the project and allow us to dedicate more time to its development.

There are several ways you can sponsor us:

Thank you for your support!

👏 Thanks

To all our contributors without this would never have been possible

⭐ Give us a star

If you like what we're doing, give us a star and share our SveltyCMS project with others

SveltyCMS Builder SveltyCMS User