File tree Expand file tree Collapse file tree 2 files changed +30
-1
lines changed Expand file tree Collapse file tree 2 files changed +30
-1
lines changed Original file line number Diff line number Diff line change
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
+
1
26
# Building with MinIO
2
27
3
28
To test console in its shipping format, you need to build it from the MinIO repository, the following step will guide
Original file line number Diff line number Diff line change 1
1
This project was bootstrapped with [ Create React App] ( https://github.com/facebook/create-react-app ) .
2
2
3
+ Requirements: ` yarn ` and [ node] ( https://nodejs.org/en/download )
4
+
3
5
## Available Scripts
4
6
5
- In the project directory, you can run:
7
+ In the ` /portal-ui ` directory, you can run:
6
8
7
9
### ` yarn start `
8
10
@@ -12,6 +14,8 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
12
14
The page will reload if you make edits.<br />
13
15
You will also see any lint errors in the console.
14
16
17
+ > Note: If it's the first time running ` yarn ` , you might need to run ` yarn install ` before the ` start ` command.
18
+
15
19
### ` yarn test `
16
20
17
21
Launches the test runner in the interactive watch mode.<br />
You can’t perform that action at this time.
0 commit comments