README.md

opencrud-admin

⚠️ THIS IS A WORK-IN-PROGRESS! (this will not work for you "out of the box")

It is currently tightly coupled to a specific GraphQL Schema until I work out ways to allow for easier customization. The ultimate goal will allow for customizations to be made by the developer and/or a content editor.

I built this as a proof of concept and for a more prisma-centric "react-admin". If this works out well, I may choose to support it long-term, as Prisma is an excellent database API but with no real open-source CMS.

The goal is to provide a CMS to connect to YOUR server, which in turn communicates with Prisma. As per Prisma's suggestions you should never expose your Prisma database directly to the client. Right now this CMS expects your server's GraphQL API to follow OpenCRUD standards, like Prisma does.

Current Requirements

• Remote GraphQL Server (like graphql-yoga)
  • Must be OpenCRUD compliant and contain required mutations and queries for each "Resource" type
  • Can communicate with your remote Prisma Server
  • Prisma datamodel must include a User type with email and password fields
• IMGIX Account (eventually optional)
• Probably More... (this is a work-in-progress afterall)

Install

yarn add opencrud-admin

Use as app (recommended)

Clone this repo

git clone danielmahon/opencrud-admin
cd opencrud-admin
yarn install

Edit files in src/config to match your GraphQL server and "Resource" configuration. This project was bootstrapped with Create React App, so you can follow instructions there for local development and deployment.

Run your app in development mode.

yarn start

If you want to install this as a library into another app, see below. This is difficult at the moment as the configuration is currently hardcoded to the config folder. Soon, you will be able to dynamically create the config at runtime.

Use as library (Soon™)

Create a new app with create-react-app

yarn create react-app my-app
cd my-app
yarn add opencrud-admin

In src/index.js replace the App import from ./App.js to opencrud-admin

// src/index.js

import React from 'react';
import ReactDOM from 'react-dom';
// import App from './App';
import App from 'opencrud-admin';
import './index.css';
import * as serviceWorker from './serviceWorker';

ReactDOM.render(<App />, document.getElementById('root'));

// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: http://bit.ly/CRA-PWA
serviceWorker.unregister();

Setup the required ENV variables in .env

REACT_APP_GRAPHQL_ENDPOINT="https://localhost:5002"
REACT_APP_IMGIX_ENDPOINT="YOUR_IMGIX_ENDPOINT"
PORT=5001
BROWSER=false
NODE_ENV=development

Run your app in development mode.

yarn start

That's it! 🎉

(Until the configuration is opened up)

Optional

Setup local SSL development using local-ssl-proxy

---

This project was bootstrapped with Create React App.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.