Development Setup
Clone main branch of Automatisch.
git clone git@github.com:automatisch/automatisch.git
Then, install the dependencies for both backend and web packages separately.
cd automatisch
# Install backend dependencies
cd packages/backend
yarn install
# Install web dependencies
cd packages/web
yarn install
Backend
Make sure that you have PostgreSQL and Redis installed and running.
WARNING
Scripts we have prepared for Automatisch work with PostgreSQL version 14. If you have a different version, you might have some problems with the database setup.
Create a .env
file in the backend package:
cd packages/backend
cp .env-example .env
Create the development database in the backend folder.
yarn db:create
WARNING
yarn db:create
commands expect that you have the postgres
superuser. If not, you can create a superuser called postgres
manually or you can create the database manually by checking PostgreSQL-related default values from the app config.
Run the database migrations in the backend folder.
yarn db:migrate
Create a seed user with user@automatisch.io
email and sample
password.
yarn db:seed:user
Start the main backend server.
cd packages/backend
yarn dev
Start the worker server in another terminal tab.
cd packages/backend
yarn worker
Frontend
Create a .env
file in the web package:
cd packages/web
cp .env-example .env
Start the frontend server in another terminal tab.
cd packages/web
yarn dev
It will automatically open http://localhost:3001 in your browser. Then, use the user@automatisch.io
email address and sample
password to login.
Docs server
cd packages/docs
yarn install
yarn dev
You can check the docs server via http://localhost:3002.