Skip to content

Commit 6538a61

Browse files
committed
docs(getting-started): refactor runs
1 parent aa1d4bd commit 6538a61

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

Diff for: README.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@
2121
* [Getting started](#getting-started)
2222
* [Docker](#docker)
2323
* [Node](#node)
24-
* [Proxmox](#proxmox)
25-
* [Cloud Providers](#cloud-providers)
2624
* [License](#license)
2725
</details>
2826

@@ -56,25 +54,30 @@ services:
5654
- '3000:3000'
5755
volumes:
5856
- ./config.yml:/app/data/config.yml
59-
- ./icons:/app/public/icons
6057
```
6158
6259
### Node
6360
64-
1. Clone repository: `git clone https://github.com/hywax/mafl.git`
65-
2. Go to the application folder: `cd mafl`
66-
3. Configure `data/config.yml`
67-
4. Install dependencies: `yarn install`
68-
5. Build application: `yarn build`
69-
6. Run `yarn preview`
61+
First, clone the repository:
7062
71-
### Proxmox
63+
```shell
64+
git clone https://github.com/hywax/mafl.git
65+
```
66+
67+
Then install dependencies and build the production bundle (I'm using `yarn` here, you can use `npm` or `pnpm` if you like):
7268

73-
...
69+
```shell
70+
yarn install
71+
yarn build
72+
```
7473

75-
### Cloud Providers
74+
Finally, run the server:
75+
76+
```shell
77+
yarn preview
78+
```
7679

77-
...
80+
The application will start with a basic configuration, which is located in the `data` folder.
7881

7982
## License
8083

0 commit comments

Comments
 (0)