Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[O2B-830] Add to global docs #900

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

graduta
Copy link
Member

@graduta graduta commented Mar 8, 2023

I have a JIRA ticket

  • branch and/or PR name(s) include(s) JIRA ID
  • issue has "Fix version" assigned
  • issue "Status" is set to "In review"
  • PR labels are selected

Notable changes for users:

  • Updated global docs on setup

@graduta graduta added the documentation Improvements or additions to documentation label Mar 8, 2023
@graduta graduta self-assigned this Mar 8, 2023
@codecov
Copy link

codecov bot commented Mar 8, 2023

Codecov Report

Merging #900 (02e4548) into main (20e3565) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #900   +/-   ##
=======================================
  Coverage   47.80%   47.80%           
=======================================
  Files         472      472           
  Lines        7322     7322           
  Branches     1384     1384           
=======================================
  Hits         3500     3500           
  Misses       3822     3822           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more


### C. :hammer_and_wrench: I want to contribute to Bookkeeping software

You are more than welcomed to contribute to Bookkeeping. Please fellow our [CONTRIBUTING](./docs/CONTRIBUTING.md) guide where you can find out more about how to set up a dev environment and how to follow our coding standards.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fellow > Please follow

Comment on lines +9 to +10
For recent versions of docker, `docker-compose` utility is now part of docker (in `docker compose`).
For compatibility reasons, create an alias or a script that aliases `docker-compose` to `docker compose`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessary following Luckasz improvement

```sh
$ npx sequelize-cli db:migrate
docker-compose exec application npm run sequelize -- db:seed:all
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker compose

Comment on lines +9 to +22
The following `.env` configuration is the bare minimum required for setup. It must be placed in the top dir.
```ini
; Database
MYSQL_ROOT_PASSWORD=cern
OPENID_ID=
OPENID_SECRET=
OPENID_REDIRECT=

JWT_SECRET=

ATTACHMENT_PATH=/var/storage

NOTIFICATION_BROKER=
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants