mirror of
https://github.com/OpenMaxIO/openmaxio-object-browser
synced 2026-07-01 07:41:18 -07:00
Update Dev Documentation (#2781)
This commit is contained in:
@@ -1,3 +1,28 @@
|
||||
# Developing Console
|
||||
|
||||
Console requires to have the [MinIO](https://github.com/minio/minio) server, Console server and the Console web app running.
|
||||
|
||||
## Running Server
|
||||
|
||||
Build the server in the main folder by running:
|
||||
```
|
||||
make
|
||||
```
|
||||
> Note: If it's the first time running the server, you might need to run `go mod tidy` to ensure you have all modules required.
|
||||
|
||||
To start the server run:
|
||||
```
|
||||
CONSOLE_ACCESS_KEY=<your-access-key>
|
||||
CONSOLE_SECRET_KEY=<your-secret-key>
|
||||
CONSOLE_MINIO_SERVER=<minio-endpoint>
|
||||
CONSOLE_DEV_MODE=on
|
||||
./console server
|
||||
```
|
||||
|
||||
## Running Web app
|
||||
Refer to `/portal-ui` [instructions](/portal-ui/README.md) to run the web app locally.
|
||||
|
||||
|
||||
# Building with MinIO
|
||||
|
||||
To test console in its shipping format, you need to build it from the MinIO repository, the following step will guide
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
|
||||
Requirements: `yarn` and [node](https://nodejs.org/en/download)
|
||||
|
||||
## Available Scripts
|
||||
|
||||
In the project directory, you can run:
|
||||
In the `/portal-ui` directory, you can run:
|
||||
|
||||
### `yarn start`
|
||||
|
||||
@@ -12,6 +14,8 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||||
The page will reload if you make edits.<br />
|
||||
You will also see any lint errors in the console.
|
||||
|
||||
> Note: If it's the first time running `yarn`, you might need to run `yarn install` before the `start` command.
|
||||
|
||||
### `yarn test`
|
||||
|
||||
Launches the test runner in the interactive watch mode.<br />
|
||||
|
||||
Reference in New Issue
Block a user