docs: Add contributing sections to homepage
This commit is contained in:
25
packages/docs/pages/contributing/contribution-guide.md
Normal file
25
packages/docs/pages/contributing/contribution-guide.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Contribution Guide
|
||||
|
||||
We are happy that you want to contribute to Automatisch. We will assist you in the contribution process. This guide will help you to get started.
|
||||
|
||||
## We develop with GitHub
|
||||
|
||||
We use GitHub to host code, track issues, and feature requests, as well as accept pull requests. You can follow those steps to contribute to the project:
|
||||
|
||||
1. Fork the repository and create your branch from the `main`.
|
||||
2. Create your feature branch (`git checkout -b feature/feature-description`)
|
||||
3. If you've added code that should be documented, update the documentation.
|
||||
4. Make sure to use the linter by running `yarn lint` command in the project root folder.
|
||||
5. Create a pull request!
|
||||
|
||||
## Use conventional commit messages
|
||||
|
||||
We use [conventional commit messages](https://www.conventionalcommits.org) to generate changelogs and release notes. Therefore, please follow the guidelines when writing commit messages.
|
||||
|
||||
## Report bugs using GitHub issues
|
||||
|
||||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/automatisch/automatisch/issues/new).
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the AGPL-3.0 license.
|
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).
|
21
packages/docs/pages/contributing/repository-structure.md
Normal file
21
packages/docs/pages/contributing/repository-structure.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Repository Structure
|
||||
|
||||
We use `lerna` with `yarn workspaces` to manage the mono repository. We have the following packages:
|
||||
|
||||
```
|
||||
.
|
||||
├── packages
|
||||
│ ├── backend
|
||||
│ ├── cli
|
||||
│ ├── docs
|
||||
│ ├── e2e-tests
|
||||
│ ├── types
|
||||
│ └── web
|
||||
```
|
||||
|
||||
- `backend` - The backend package contains the backend application and all integrations.
|
||||
- `cli` - The cli package contains the CLI application of Automatisch.
|
||||
- `docs` - The docs package contains the documentation website.
|
||||
- `e2e-tests` - The e2e-tests package contains the end-to-end tests for the internal usage.
|
||||
- `types` - The types package contains the shared types for both the backend and web packages.
|
||||
- `web` - The web package contains the frontend application of Automatisch.
|
Reference in New Issue
Block a user