GithubHelp home page GithubHelp logo

pocketcms's Introduction

PocketCMS

build

PocketCMS is an open source content management system leveraging PocketBase as its foundation. PocketCMS offers:

  • a user-facing CMS admin portal alongside PocketBase's admin UI
  • using PocketBase's client-side SDKs within your application for fetching data from PocketCMS

PocketCMS's mission is to bring the simplicity of PocketBase's developer experience and admin interface to less tech-savvy users who only need to focus on managing website content.

Instructions

By installing PocketCMS, you are essentially also installing PocketBase with some additional features and plus another embedded single-page-application acting as the CMS admin portal. The instructions for deploying are therefore very similar to PocketBase's.

To run as a standalone application, download the prebuilt executable from the Releases page. Once downloaded, extract the archive and run ./pocketcms serve in the extracted directory.

From there, PocketBase will run in its usual path of localhost:8090/_/ and PocketCMS will run at localhost:8090/cms/. Before using PocketCMS, some initial collection and user setup is required.

Initial Setup

  1. log in to pocketbase at localhost:8090/_/
  2. visit pocketcms at localhost:8090/cms/ and create your first user
  3. voila!

Now that you are set up, any collections you create inside PocketBase prefixed with pcms_ and with api rules not set to admin only, those collections will be available in PocketCMS.

To fetch from these collections, you can use the PocketBase client-side SDKs just as you would any other PocketBase collection! For more information on fetching data from PokcetCMS/PocketBase, see PocketBase's documentation.

Development

Feel free to raise issues and PRs! Any suggestions are welcome.

To run pocketbase and pocketcms

  1. Clone the repo
  2. run
go mod tidy
go run main.go serve

UI Development

  1. Run pocketcms like above
  2. in another terminal, open the ui/ dir and run:
pnpm run dev

which should spin up vite at localhost:3000. This will give you all the HMR goodness.

pocketcms's People

Contributors

parkuman avatar moalamri avatar

Stargazers

 avatar iLLeniumStudios avatar Philipp avatar Nisan Coşkun avatar  avatar H avatar GuangyiLi avatar esteban avatar KarlitosD avatar F.Baube avatar

Watchers

 avatar  avatar

pocketcms's Issues

Auto setup PocketCMS

Just like the magic with PocketBase. We want PocketCMS to auto setup the necessary collections & fields on first use.

automatic setup on first load of PocketCMS

Flow is as follows

graph TD
	A[Visit PocketCMS] --> D[Logged in to PocketBase already?]
	F[Visit PocketBase] --> B[Complete PocketBase installer]
	B --> A
	D -->|no, redirect to PocketBase| F
	D -->|yes| E[complete PocketCMS installer]
Loading

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.