https://github.com/alineacms/alinea

Content management, streamlined
https://github.com/alineacms/alinea

bun cms content content-management-system git headless nextjs nodejs typescript

Last synced: 28 days ago
JSON representation

Content management, streamlined

• Host: GitHub
• URL: https://github.com/alineacms/alinea
• Owner: alineacms
• License: mit
• Created: 2021-09-09T09:24:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T08:22:35.000Z (8 months ago)
• Last Synced: 2024-04-13T03:37:58.974Z (7 months ago)
• Topics: bun, cms, content, content-management-system, git, headless, nextjs, nodejs, typescript
• Language: TypeScript
• Homepage: https://alinea.sh
• Size: 50.5 MB
• Stars: 735
• Watchers: 7
• Forks: 38
• Open Issues: 37
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • Contributing: contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/alinea.svg)](https://npmjs.org/package/alinea)

[![install size](https://packagephobia.com/badge?p=alinea)](https://packagephobia.com/result?p=alinea)

# [![Alinea CMS logo](https://github.com/alineacms/alinea/raw/HEAD/apps/web/public/logo.svg)](https://alinea.sh)

Alinea is a modern content management system.

- Content is stored in flat files and committed to your repository

- Content is easily queryable through an in-memory SQLite database

- Content is fully typed

## Get started

Install alinea in your project directory

```sh

npm install alinea

```

Initialize alinea's config file

```sh

npx alinea init --next

```

Open the dashboard to have a look around

```sh

npx alinea dev

```

[Start configuring types and fields →](https://alinea.sh/docs/configuration)

## Configure

Configure alinea in `cms.tsx`

```tsx

import {Config, Field} from 'alinea'

const Blog = Config.document('Blog', {

  contains: ['BlogPost']

})

const BlogPost = Config.document('Blog post', {

  fields: {

    title: Field.text('Blog entry title'),

    body: Field.richText('Body text')

  }

})

```

[Type options and fields →](https://alinea.sh/docs/configuration)

## Query

Retrieve content fully-typed and filter, order, limit as needed.  

Select only the fields you need.

```tsx

import {Query} from 'alinea'

const blogAndPosts = Query(Blog).select({

  title: Blog.title,

  posts: Query.children(BlogPost).select({

    title: BlogPost.title

  })

})

console.log(await cms.get(blogAndPosts))

```

[See the full api →](https://alinea.sh/docs/content/query)

Content is available during static site generation and when server side querying.  

Content is bundled with your code and can be queried with zero network overhead.

[How alinea bundles content →](https://alinea.sh/docs/content)

## Deploy anywhere

Alinea supports custom backends that can be hosted as a simple Node.js process or on serverless runtimes.

[Setup your backend →](https://alinea.sh/docs/deploy)

## How to contribute to this project

Have a question or an idea? Found a bug? Read how to [contribute](contributing.md).