Skip to content

Commit

Permalink
chore: update readme, docs and package.jsons
Browse files Browse the repository at this point in the history
  • Loading branch information
StructuralRealist committed Sep 25, 2023
1 parent 253bfbd commit 6696528
Show file tree
Hide file tree
Showing 22 changed files with 1,927 additions and 678 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

---

**Curator** is full-stack, customizable and batteries-included CMS built on [Strapi](https://www.strapi.io) and [Next.js](https://nextjs.org).
**Curator** is a batteries-included framework for on [Strapi](https://www.strapi.io).

---

Expand All @@ -23,10 +23,15 @@ Documentation is available [here](https://its-devtastic.github.io/curator/).

## 💫 Features

- 🎨 Extremely customizable admin
- ✍️ Integrated authoring experience
- 🔋 Batteries-included: content versioning, audit logs, secrets manager, dashboard, rich text editor...
- 📱 Mobile-friendly
- (Truly) customizable, mobile-friendly admin
- Content versioning
- Dashboard
- Audit logs
- Admin user avatars
- Secrets manager
- Autosave
- Dark mode
- Flexible plugin system

## Quick Start

Expand All @@ -40,4 +45,5 @@ Curator Studio will run on http://localhost:1338

## Motivation

We need a modern WordPress alternative that is easy to customize and batteries-included. Curator is the glue between Strapi and Next.js.
Strapi is a popular headless CMS, but it's missing some basic features and its admin is notoriously uncustomizable.
Curator offers a Strapi plugin that adds those features, and an alternative admin app that is easier to customize.
1,902 changes: 1,461 additions & 441 deletions docs/package-lock.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,28 @@
"type": "git",
"url": "https://github.com/its-devtastic/curator"
},
"author": "Devtastic <hi@devtastic.build>",
"author": "Devtastic <hi@devtastic.io>",
"maintainers": [
{
"name": "Leon van der Grient",
"url": "https://github.com/StructuralRealist",
"email": "leon@devtastic.build"
"email": "leon@devtastic.io"
}
],
"license": "MIT",
"homepage": "https://github.com/its-devtastic/curator#readme",
"dependencies": {
"next": "^13.4.19",
"next": "^13.5.2",
"next-plausible": "^3.11.1",
"nextra": "2.12.3",
"nextra-theme-docs": "2.12.3",
"nextra": "2.13.0",
"nextra-theme-docs": "2.13.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/node": "18.17.14",
"autoprefixer": "^10.4.15",
"postcss": "^8.4.29",
"autoprefixer": "^10.4.16",
"postcss": "^8.4.30",
"prettier": "^3.0.3",
"tailwindcss": "^3.3.3",
"typescript": "^5.1.6"
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import logo from "../../public/logo.svg";
}}
/>

Curator is a full-stack CMS built on Strapi and Next.js. It's customizable, batteries-included and has a great developer experience.
**Curator** is a batteries-included framework for on [Strapi](https://www.strapi.io).

## Features

Expand All @@ -38,5 +38,5 @@ npx create-curator-app@latest

## Motivation

We need a modern WordPress alternative that is easy to customize and batteries-included. Curator combines a headless CMS
with a modern frontend framework and a powerful admin.
Strapi is a popular headless CMS, but it's missing some basic features and its admin is notoriously uncustomizable.
Curator offers a Strapi plugin that adds those features, and an alternative admin app that is easier to customize.
6 changes: 6 additions & 0 deletions docs/pages/docs/studio/configuration/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ Path relative to the `public` directory referencing an icon image. Used in the a
`string`

The title that is display in the app header next to the icon. For example `ACME CMS`.

## website

`string`

URL to the website for which Studio is the CMS. Adds a link in the main menu.
26 changes: 2 additions & 24 deletions docs/pages/docs/studio/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,6 @@ Curator Studio is an **alternative admin** for [Strapi](https://www.strapi.io).
- 🔌 Plugins
- 💯 100% TypeScript

## Quick Start

Create a new Curator project with the Create Curator App tool:

```shell
npx create-curator-app@latest cms
```

Next, go into the newly created `cms` directory and install the dependencies. When that's done, run

```shell
npm run dev
```

Your Curator project will run on http://localhost:1338

## Motivation

Strapi is the most popular JavaScript headless CMS available but its admin is notoriously uncustomizable. Curator
provides an alternative admin that is built with React and easy to customize and extend. It uses popular frameworks and
libraries that should be familiar to many developers.

## Limitations

There are some limitations on what you can do with Curator, compared to the Strapi admin.
Expand All @@ -61,8 +39,8 @@ There are some limitations on what you can do with Curator, compared to the Stra
| Permissions | ✅️ |
| Dark mode ||
| Filters ||
| API keys ||
| Webhooks ||
| Media library | 🚧️ (Cropping is currently not supported) |
| Role management ||
| API keys ||
| Webhooks ||
| Content-type builder | ❌ (not planned) |
2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import pkgJson from "../../packages/studio/package.json";
</div>

<div className="text-2xl md:text-3xl text-slate-700 text-center max-w-2xl mx-auto mt-12 [&_a]:text-indigo-500">
Modern full-stack CMS built on Strapi and Next.js
The Strapi Framework
</div>

<div className="flex flex-col items-center">
Expand Down
Binary file added docs/public/devtastic_logo.webp
Binary file not shown.
Binary file modified docs/public/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 9 additions & 5 deletions docs/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const config: DocsThemeConfig = {
useNextSeoProps() {
return {
title: "Curator",
description: "Modern full-stack CMS built on Strapi and Next.js",
description: "The Strapi Framework",
};
},
head: () => (
Expand All @@ -37,10 +37,14 @@ const config: DocsThemeConfig = {
</a>
.
</div>
<div>
Created by{" "}
<a href="https://www.devtastic.build" target="_blank">
Devtastic
<div style={{ display: "flex", alignItems: "center", gap: 16 }}>
<span>Created by</span>
<a href="https://www.devtastic.io" target="_blank">
<img
src="/devtastic_logo.webp"
alt=""
style={{ width: 200, height: "auto" }}
/>
</a>
</div>
</div>
Expand Down
Binary file modified media/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6696528

Please sign in to comment.