Skip to content

Commit 61c864e

Browse files
authored
Update Dev Documentation (#2781)
1 parent 0e0f503 commit 61c864e

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

DEVELOPMENT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
# Developing Console
2+
3+
Console requires to have the [MinIO](https://github.com/minio/minio) server, Console server and the Console web app running.
4+
5+
## Running Server
6+
7+
Build the server in the main folder by running:
8+
```
9+
make
10+
```
11+
> 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.
12+
13+
To start the server run:
14+
```
15+
CONSOLE_ACCESS_KEY=<your-access-key>
16+
CONSOLE_SECRET_KEY=<your-secret-key>
17+
CONSOLE_MINIO_SERVER=<minio-endpoint>
18+
CONSOLE_DEV_MODE=on
19+
./console server
20+
```
21+
22+
## Running Web app
23+
Refer to `/portal-ui` [instructions](/portal-ui/README.md) to run the web app locally.
24+
25+
126
# Building with MinIO
227

328
To test console in its shipping format, you need to build it from the MinIO repository, the following step will guide

portal-ui/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
22

3+
Requirements: `yarn` and [node](https://nodejs.org/en/download)
4+
35
## Available Scripts
46

5-
In the project directory, you can run:
7+
In the `/portal-ui` directory, you can run:
68

79
### `yarn start`
810

@@ -12,6 +14,8 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
1214
The page will reload if you make edits.<br />
1315
You will also see any lint errors in the console.
1416

17+
> Note: If it's the first time running `yarn`, you might need to run `yarn install` before the `start` command.
18+
1519
### `yarn test`
1620

1721
Launches the test runner in the interactive watch mode.<br />

0 commit comments

Comments
 (0)