Skip to content

Commit

Permalink
Docs for dev
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur-flam committed Jan 2, 2022
1 parent 33afb52 commit 2fc4ade
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Each section has its own README:
## Where to start
If you want to contribute to the project but do not know where to start, or what to work on, don't hesitate to chat with the maintainers. QA-Board has many parts and much can be improved. We'll do our best to find something that matches your experience and has a meaningful impact on the project. Before you work on a big feature, don't hesitate to open an issue and discuss it.

**To start a dev server:**

```bash
# check requirements in webapp/README.md
cd webapp
npm install

# see more into in docker-compose.yml and backend/README.md
docker-compose -f docker-compose.yml -f development.yml up -d
```


## Openness
Currently, we use internally at Samsung a private fork of QA-Board. The differences are very small, mainly having to do with hardcoded configuration and CI. Our goal to move to a process where we first contribute to the public repository, then merge back the changes.
Expand Down
1 change: 1 addition & 0 deletions webapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Web frontend for QA-Board.

- Install the third-party packages and run the application:
```bash
cd webapp
npm install
npm start
#=> listenning on port 3000
Expand Down

0 comments on commit 2fc4ade

Please sign in to comment.