docs: Add contributing sections to homepage
This commit is contained in:
76
packages/docs/pages/contributing/development-setup.md
Normal file
76
packages/docs/pages/contributing/development-setup.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Development Setup
|
||||
|
||||
Clone main branch of Automatisch.
|
||||
|
||||
```bash
|
||||
git clone git@github.com:automatisch/automatisch.git
|
||||
```
|
||||
|
||||
Then, install the dependencies.
|
||||
|
||||
```bash
|
||||
cd automatisch
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Backend
|
||||
|
||||
Make sure that you have **PostgreSQL** and **Redis** installed and running.
|
||||
|
||||
Create a `.env` file in the backend package:
|
||||
|
||||
```bash
|
||||
cd packages/backend
|
||||
cp .env-example .env
|
||||
```
|
||||
|
||||
Create the development database in the backend folder.
|
||||
|
||||
```bash
|
||||
yarn db:create
|
||||
```
|
||||
|
||||
Run the database migrations in the backend folder.
|
||||
|
||||
```bash
|
||||
yarn db:migrate
|
||||
```
|
||||
|
||||
Create a seed user with `user@automatisch.io` email and `sample` password.
|
||||
|
||||
```bash
|
||||
yarn db:seed:user
|
||||
```
|
||||
|
||||
Start the main backend server.
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Start the worker server in another terminal tab.
|
||||
|
||||
```bash
|
||||
yarn worker
|
||||
```
|
||||
|
||||
## Frontend
|
||||
|
||||
Create a `.env` file in the web package:
|
||||
|
||||
```bash
|
||||
cd packages/web
|
||||
cp .env-example .env
|
||||
```
|
||||
|
||||
Start the frontend server in another terminal tab.
|
||||
Open [http://localhost:3001](http://localhost:3001) with your browser to see the result. Then, use the `user@automatisch.io` email address and `sample` password to login.
|
||||
|
||||
## Docs server
|
||||
|
||||
```bash
|
||||
cd packages/docs
|
||||
yarn dev
|
||||
```
|
||||
|
||||
You can check the docs server via [http://localhost:3002](http://localhost:3002).
|
Reference in New Issue
Block a user