docs: Complete installation doc
This commit is contained in:
@@ -1,44 +1,20 @@
|
|||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
<!-- TODO: Add instructions to install PostgreSQL and specify supported node versions -->
|
You can install Automatisch by using docker compose.
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
```bash
|
```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
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- TODO: Check requirements of https usage and revise the document accordingly -->
|
|
||||||
|
|
||||||
## Let's discover!
|
## 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).
|
||||||
|
Reference in New Issue
Block a user