https://github.com/fastschema/fastschema

All-in-One Backend as a Service with Headless CMS Power
https://github.com/fastschema/fastschema

backend backend-as-a-service cms framework golang headless-cms low-code no-code rbac react

Last synced: about 23 hours ago
JSON representation

All-in-One Backend as a Service with Headless CMS Power

Host: GitHub
URL: https://github.com/fastschema/fastschema
Owner: fastschema
License: mit
Created: 2024-04-02T04:58:55.000Z (about 1 year ago)
Default Branch: develop
Last Pushed: 2025-06-03T16:20:31.000Z (27 days ago)
Last Synced: 2025-06-03T21:25:30.863Z (27 days ago)
Topics: backend, backend-as-a-service, cms, framework, golang, headless-cms, low-code, no-code, rbac, react
Language: Go
Homepage: https://fastschema.com
Size: 3.35 MB
Stars: 447
Watchers: 5
Forks: 39
Open Issues: 18
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-go - fastschema/fastschema - in-One Backend as a Service with Headless CMS Power ☆`463` (Web Frameworks / Utility/Miscellaneous)
awesome-go - fastschema/fastschema - in-One Backend as a Service with Headless CMS Power ☆`463` (Web Frameworks / Utility/Miscellaneous)

README

        


  

    

      

      

    

  





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





  Contributing Guidelines

  ·

  Submit an Issue

  






  FastSchema is a Backend as a Service (BaaS) and Go web framework for building dynamic web applications. Designed to simplify backend development, FastSchema automates the generation of databases, provides ready-to-use CRUD APIs, and offers tools for managing structured content effortlessly



## Table of Contents

- [Introduction](#introduction)

- [Try it out](#try-it-out)

  - [Run the Docker Container](#run-the-docker-container)

- [Overview](#overview)

- [Use Cases](#use-cases)

- [Web Framework](#web-framework)

- [Features](#features)

- [Documentation](#documentation)

- [Roadmap](#roadmap)

- [Testing](#testing)

- [Dependencies](#dependencies)

- [Contributing](#contributing)

- [Community](#community)

- [License](#license)

## Introduction

Check out our introduction video to get a quick overview of FastSchema:

[![FastSchema Introduction](https://img.youtube.com/vi/SQTo1ZngMRA/maxres1.jpg)](https://www.youtube.com/watch?v=SQTo1ZngMRA)

## Try it out

Launch a complete backend in seconds or utilize it as a versatile web framework. FastSchema combines the ease of a Backend as a Service with the flexibility to manage real-time data and structured content seamlessly.

### Run the Docker Container:

```bash

docker pull ghcr.io/fastschema/fastschema:latest

docker run \

  -p 8000:8000 \

  -v ./data:/fastschema/data \

  ghcr.io/fastschema/fastschema:latest

```

**Example output:**

```

> APP_KEY is not set. A new key is generated and saved to /fastschema/data/.env

> Using the default sqlite db file path: /fastschema/data/fastschema.db

> Visit the following URL to setup the app: http://localhost:8000/dash/setup/?token=lUDRgoTUUNDsjCcitgGFTqwMZQPmYvlU

```

Now you can access to the FastSchema setup page by

visiting [http://localhost:8000/setup?token=\{token\}](http://localhost:8000?token={token}) (The setup token is

displayed in the terminal).

> **Note:** FastSchema is currently in beta and under active development. We welcome feedback, contributions, and

> suggestions from the community to help improve the platform and make it more robust and feature-rich.

## Overview

FastSchema core features are built on top of `schema`, a blueprint that outlines the structure of your content. This

schema acts as the foundation upon which FastSchema builds your database tables and API endpoints, streamlining the

development process and allowing you to focus on creating rich, dynamic content.



  



## Use Cases

- **A BaaS platform with Headless CMS capabilities (No-Code Solution).**

  FastSchema is an ideal solution for building backend applications, including headless CMS, with dynamic content modeling and real-time capabilities—all without writing a line of code.

  It is designed to support API-first development, allowing you to define your content models and generate RESTful APIs

  effortlessly.

  With two line of commands, you can create a new project, define your content models, and start creating content

  instantly.

- **A Framework for web development**

  FastSchema is designed to be used as a framework for building web applications. It provides a set of tools and

  packages that simplify the development process.

  `Resource` is a core concept that represents an access point to your data. By defining resources, you can create

  custom endpoints and customize the behavior of your APIs.

  `Hooks` are functions that are executed before or after an operation is performed on a resource. A `Hook` can be

  a `resolver hook`, `database hook`, or `application hook`. They allow you to add custom logic to your APIs and extend

  the functionality of FastSchema.

  `ORM` is a powerful tool that simplifies the interaction with your database. It provides a set of methods for

  querying, creating, updating, and deleting records in your database.

## Web Framework

```go

package main

import (

	"fmt"

	"log"

	"github.com/fastschema/fastschema"

	"github.com/fastschema/fastschema/db"

	"github.com/fastschema/fastschema/fs"

)

func main() {

	app, _ := fastschema.New(&fs.Config{

		SystemSchemas: []any{Tag{}, Blog{}},

	})

	app.API().Add(fs.Post("/blogvote", func(c fs.Context, vote *Payload) (*Response, error) {

		_, err := db.Mutation[Blog](app.DB()).

			Where(db.EQ("id", vote.ID)).

			Update(c.Context(), fs.Map{

				"$expr": fs.Map{"vote": "vote + 1"},

			})

		return &Response{

			Success: err == nil,

			Message: fmt.Sprintf("Vote for %d: %v", vote.ID, err),

		}, nil

	}))

	log.Fatal(app.Start())

}

```

## Features

FastSchema offers a comprehensive suite of features designed to streamline and simplify the process of building and

managing dynamic web applications.

- **Automated Database Generation:** FastSchema automatically generates the necessary database tables based on your

  schema definition with flexible relationships model, eliminating the need for manual setup.

- **RESTful API Generation:** RESTful APIs are automatically generated based on the schema definition. Whenever you

  create or update a schema, the corresponding API endpoints are updated accordingly.

- **Dynamic Content Modeling:** Easily create and modify content models through the intuitive admin UI, with changes

  reflected instantly in the schema definition file.

- **Built-in File Management:** FastSchema provides a built-in file manager to manage media assets, enabling you to

  upload, organize, and serve files seamlessly.

- **Built-in Admin Control Panel:** FastSchema comes with a built-in admin control panel that allows you to manage

  content, users, manage permissions, and more.

- **Database Support:** MySQL, PostgreSQL, SQLite.

- **Role-Based Access Control:** Define roles and permissions to control access to content and features.

- **OpenAPI Specification (OAS) Generation:** FastSchema automatically generates OpenAPI Specification (OAS)

  documentation for your APIs, making it easy to understand and consume your APIs.

- **Extensible and Flexible:** Extend and customize FastSchema with Go code, build extensive features by leveraging the

  power of Resources, Hooks, ORM, and more.

- **Real-time Updates:** FastSchema supports real-time updates, allowing you to build dynamic web applications that

  update in real-time without the need for manual refresh.

- **Plugin System:** FastSchema comes with a plugin system that allows you to extend the functionality of the platform with custom plugins.

## Documentation

For more information on how to get started with FastSchema, check out our [documentation](https://fastschema.com).

## Roadmap

- [x] Improve documentation and testing.

- [x] Add auth provider.

- [x] OpenAPI generator.

- [x] Real-time updates.

- [x] Plugin system.

- [ ] GraphQL support.

- [ ] Webhooks.

- [ ] Client SDKs.

    - [x] [JavaScript SDK](https://fastschema.com/docs/sdk/javascript-sdk).

## Testing

FastSchema comes with a suite of automated tests to ensure the stability and reliability of the platform.

_FastSchema come with integration tests that require a database connection. You can use the following command to create

DB containers._

```bash

cd tests/integration

docker compose up -d

```

To run the tests, execute the following command:

```bash

go test ./...

```

You can skip the integration tests by running tests for packages only.

```bash

./tests/test.sh ./schema

```

## Dependencies

FastSchema is built using the Go programming language and leverages a number of open-source libraries to provide its

core functionality. Some of the key dependencies include:

- [Fiber](https://gofiber.io/)

- [Ent](https://entgo.io/)

- [Rclone](https://rclone.org/)

- [Zap](https://pkg.go.dev/go.uber.org/zap)

- [Next.js](https://nextjs.org/)

- [Shadcn](https://ui.shadcn.com/)

- [TipTap](https://www.tiptap.dev/)

## Contributing

Feel free to dive in! [Open an issue](https://github.com/fastschema/fastschema/issues/new) or submit PRs.

Guidelines for

[contributing][contributing].

We welcome contributions from the community and encourage developers to get involved in the project. Whether you're a seasoned developer or just getting started, there are plenty of ways to contribute to FastSchema.

## Community

Join the conversation and help the community.

- [Discord][discord]

- [X (formerly Twitter)](https://x.com/fastschema)

- YouTube: *updating*

- StackOverflow: *updating*

## License

[MIT](LICENSE) © Nguyen Ngoc Phuong and Contributors

**Enjoy using FastSchema? Give our repo a shiny star :star:!**

[contributing]: CONTRIBUTING.md

[discord]: https://discord.gg/Auy2Zr3Ycf

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/fastschema/fastschema

Awesome Lists containing this project

README