add documentation guides for contributions, testing and code of conduct #196
Conversation
Morphclue
added
documentation
| ```shell | ||
| git clone --depth 1 --branch master https://github.com/Morphclue/apollusia | ||
| cd apollusia | ||
| docker compose up -d |
There was a problem hiding this comment.
For local development, it’s generally better to use pnpm commands for the frontend and backend, as it provides faster rebuild times and smoother debugging. So I would advise developers to only start the database / keycloak containers.
There was a problem hiding this comment.
@lcrojano
I've added a new docker-compose file that can be used for dev-setup.
It can be started with docker-compose -f docker-compose.dev.yml up and after that pnpm serve:frontend and pnpm serve:backend should be used. Either with 3 terminals or 2 and a -d detach flag for compose.
There was a problem hiding this comment.
We should probably also get rid of this section and all the related information that is already mentioned in the SETUP-GUIDE.
Co-authored-by: Julian Holfeld <[email protected]>
| Create an `.env` file in the backend directory and add the following environment variables: | ||
|
|
||
| ```properties | ||
| EMAIL_HOST=<smtp host> | ||
| EMAIL_PORT=25 # optional, alternatively 587, or 465 for SSL | ||
| EMAIL_SSL=false # optional | ||
| EMAIL_STARTTLS=false # optional | ||
| EMAIL_USER=<username> | ||
| EMAIL_PASSWORD=<password> | ||
| EMAIL_FROM=<sender email> | ||
| EMAIL_NAME=Apollusia # optional sender display name | ||
| VAPID_PUBLIC_KEY=<vapid public key> # for push notifications | ||
| VAPID_PRIVATE_KEY=<vapid private key> # for push notifications | ||
| CONTACT_OPERATOR=<contact operator> | ||
| CONTACT_MAIL=<contact email> | ||
| CONTACT_ADDRESS=<contact address> | ||
| ``` | ||
|
|
||
| VAPID keys can be generated using the following command: | ||
|
|
||
| ```bash | ||
| npx web-push generate-vapid-keys | ||
| ``` |
There was a problem hiding this comment.
I've just noticed that this section is also missing completly.
| ```shell | ||
| git clone --depth 1 --branch master https://github.com/Morphclue/apollusia | ||
| cd apollusia | ||
| docker compose up -d |
There was a problem hiding this comment.
We should probably also get rid of this section and all the related information that is already mentioned in the SETUP-GUIDE.
This pr closes #195 by adding:
CODE-OF-CONDUCT.md
Establishes guidelines for contributing respectfully, ensuring a positive and inclusive community atmosphere.
docs/CONTRIBUTING.md
Details contribution instructions, including pull request guidelines and coding standards to streamline the contribution process.
docs/CYPRESS-TESTING-GUIDE.md
Provides a comprehensive setup and usage guide for end-to-end testing with Cypress, tailored for this project’s structure.
docs/JEST-TESTING-GUIDE.md
Outlines steps for configuring and executing unit and integration tests using Jest, helping maintain code reliability and quality.
docs/SETUP-GUIDE.md
Step-by-step installation and configuration guide for newcomers to quickly get Apollusia up and running locally.