Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure installation docs #1511

Merged
merged 2 commits into from
Jan 4, 2023
Merged

Restructure installation docs #1511

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6389af
Restructure installation docs
Janpot Jan 4, 2023
58a3dd5
numbering
Janpot Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/data/toolpad/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

<p class="description">Setup Toolpad to run on your own machine.</p>

## Installing Docker
## With Docker

In order to run Toolpad you will need to have Docker set up on your machine. Follow [official instructions](https://www.docker.com/get-started/) to get started.
### Prerequisites

## Downloading Toolpad
- A Docker and Docker Compose installation. Follow [official instructions](https://www.docker.com/get-started/) to get started.

Toolpad runs inside a docker container so you first need to download the docker compose file. Run following command in your terminal:
### Steps

```sh
curl -LO https://raw.githubusercontent.com/mui/mui-toolpad/master/docker/compose/docker-compose.yml
```
1. Download our basic Docker Compose configuration:

## Running Toolpad
```sh
curl -LO https://raw.githubusercontent.com/mui/mui-toolpad/master/docker/compose/docker-compose.yml
```

Now you need to run the docker container by running the following command:
This file contains a basic configuration, setting up a database and the Toolpad application server. You can use it as a starting point or for local development.

```sh
docker-compose -f docker-compose.yml up -d
```
1. Run the docker compose services with:

## Opening Toolpad
```sh
docker-compose -f docker-compose.yml up -d
```

You should now be able to open Toolpad on http://localhost:3000/.
1. Build and deploy applications on http://localhost:3000/.