Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 2.75 KB

README.md

File metadata and controls

96 lines (61 loc) · 2.75 KB
Raw

Einstore web admin UI

CircleCI

Trying Einstore

If you want to just try Einstore go to https://github.com/Einstore/Einstore for the easiest setup with Docker.
This repository is for customizing the admin UI.

Docker-compose

Use make, make help prints all avaible commands.

Direnv is used for adding bin-docker to PATH

Ports are exposed using docker-compose.override.yaml

For initial login in basic data is email core@liveui.io, default password: sup3rS3cr3t

Install

  • yarn install Install all dependencies

Usage

In the project directory, you can run:

Make helper scripts

Usage:
  make <target>

Targets:
  help           Display this help
  yarn-install   Runs yarn install in docker
  up             Does docker-compose up, automaticly create docker-compose.override.yaml
  update         Update to the latest docker images
  clean          Deletes all containers and volumes. WILL DROP ALL DB DATA
  install-db     Install basic data
  install-demo   Install demo data
  direnv         Create .envrc for bin-docker
  local          Start against local development API server

YARN

yarn start

  • You need to provide URL to Einstore API with env variable:
# Your local API
REACT_APP_API_URL=http://localhost:8080 yarn start

# or just the following using our Makefile
make local

# Try our running demo
REACT_APP_API_URL=https://demo.einstore.io/api yarn start

Runs the app in development mode.
Open http://localhost:3000 to view in the browser.

The page will reload, should you make edits, on file save.
You will also see any lint errors in the console.

Test run, connected to our demo API
REACT_APP_API_URL=https://demo.einstore.io/api yarn start
Run with SENTRY_DSN
REACT_APP_API_URL=https://demo.einstore.io/api REACT_APP_SENTRY_DSN=https://secret@sentry.mangoweb.org/your-project yarn start

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Warning! By default yarn build expects you to manually replace %REACT_APP_API_URL% inside public/index.html with URL to EinstoreCore API. Or you can provide it with env variable in build command.