https://github.com/prest/prestd-buildui

A "Django Admin" like created in React to support pREST interactions
https://github.com/prest/prestd-buildui

admin nextjs prest prest-admin react react-admin react-dashboard reactjs

Last synced: 3 days ago
JSON representation

A "Django Admin" like created in React to support pREST interactions

• Host: GitHub
• URL: https://github.com/prest/prestd-buildui
• Owner: prest
• Created: 2021-07-19T21:34:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-07T17:47:26.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T05:33:38.547Z (7 months ago)
• Topics: admin, nextjs, prest, prest-admin, react, react-admin, react-dashboard, reactjs
• Language: TypeScript
• Homepage:
• Size: 1.16 MB
• Stars: 24
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Build UI - prestd server (PostgreSQL ➕ REST)

Build UI, is **"Django Admin"** _like_ created in React to support prestd interactions.

### How use it

We use (and recommend) **node version 14**, to avoid messing up your environment it is recommended to use a name version control, e.g. [`nvm`](https://github.com/nvm-sh/nvm):

```sh

nvm install $(cat .nvmrc) # or nvm use $(cat .nvmrc)

```

`buildui` depends on some services (postgresql and prestd server), to simplify the creation of your environment we recommend to use **docker**, to make it even easier we wrote a _[docker compose](https://docs.docker.com/compose/)_ (contained here in the repository):

```sh

docker-compose up -d postgres prestd

```

To install the libraries on your node (we use [`yarn`](https://yarnpkg.com/)):

```sh

yarn install

yarn dev -p 3001 # the default next port (3000) we use in prestd

```

If you want to set the prestd address use the `PREST_URL` environment variable:

```sh

PREST_URL= yarn dev -p 3001

```

> ``: if you ran **prestd** via docker the url will be `http://127.0.0.1:3000`

### How use Docker

> buildui is under development, we have not yet made a docker image available

**soon docker image:**

```sh

docker pull ghcr.io/prest/buildui

docker run -it -e PREST_URL= -p 3001:3001 ghcr.io/prest/buildui

```

## Issues

> The [issue listing](https://github.com/prest/prest/issues?q=is%3Aissue+is%3Aopen+label%3Aproduct%2Fadmin) should be kept in the ["main" repository (_api server_)](https://github.com/prest/prest), centralizing all demands helps us give visibility to all products