From b253040d0a95088663d8589fab10e3a0a27db9d2 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Mon, 12 Sep 2022 02:04:05 +0300 Subject: [PATCH] docs: Complete installation doc --- packages/docs/pages/guide/installation.md | 46 ++++++----------------- 1 file changed, 11 insertions(+), 35 deletions(-) diff --git a/packages/docs/pages/guide/installation.md b/packages/docs/pages/guide/installation.md index 65980452..16e992ec 100644 --- a/packages/docs/pages/guide/installation.md +++ b/packages/docs/pages/guide/installation.md @@ -1,44 +1,20 @@ # Installation - - -Automatisch supports both npm and docker installation. - -### npm - -You can try Automatisch without installing by using [npx](https://docs.npmjs.com/cli/v8/commands/npx). +You can install Automatisch by using docker compose. ```bash -npx automatisch +# Clone the repository +git clone git@github.com:automatisch/automatisch.git + +# Go to the repository folder +cd automatisch/docker/compose + +# Start +docker compose up ``` -Or you can install Automatisch globally via [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). - -```bash -npm install automatisch -g -``` - -You need to run the start command after the installation. - -```bash -automatisch start -``` - -### docker - -You can also use [docker](https://docs.docker.com/get-docker/) to install Automatisch. - -```bash -docker run -it \ - --name automatisch \ - -p 3000:3000 \ - automatisch start -``` - - - ## Let's discover! -✌️ That's it; you have Automatisch running. Let's check it out by browsing [http://localhost:3000](#) +✌️ That's it; you have Automatisch running. Let's check it out by browsing `http://localhost:3000` You can use `user@automatisch.io` email address and `sample` password to login to Automatisch. -If you see any problem while installing Automatisch, let us know via [github issues](#) or our [discord server](https://discord.gg/dJSah9CVrC). +If you see any problems while installing Automatisch, let us know via [github issues](#) or our [discord server](https://discord.gg/dJSah9CVrC).