Skip to content

Commit

Permalink
chore: weblate config & readme updates (#1210)
Browse files Browse the repository at this point in the history
  • Loading branch information
julianpoy authored Jan 1, 2024
2 parents 6f23b2d + d9b6773 commit 5f26e4a
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 3 deletions.
5 changes: 4 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,7 @@ www
.angular


/.nx/cache
/.nx/cache

packages/frontend/src/assets/i18n/*.json
!packages/frontend/src/assets/i18n/en-us.json
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,25 @@ When contributing or suggesting code for RecipeSage, you irrevocably grant Recip

# 🐤 Contributing

Setting-up your development environment.
## Translations

Translations can be contributed via the RecipeSage Weblate instance at [https://weblate.recipesage.com](https://weblate.recipesage.com) which automatically syncs to this repository. You can login there with a Github account and get started translating.

If you'd rather translate the JSON files directly, you're welcome to do that as well. You can find all of the corresponding language files [here](https://github.com/julianpoy/RecipeSage/tree/master/packages/frontend/src/assets/i18n).

Entirely AI-generated translations are not currently accepted, since they very frequently produce low-quality and inaccurate results. When using AI to assist in your translation efforts, please use DeepL or Google Translate - do not translate using ChatGPT.

## Code

Code contributions are always very, very welcome. I'm very open to collaborating, and if there's a feature you'd like to see come to RecipeSage I'd love to help you facilitate that.

Although you don't have to reach out before starting work and contributing a PR, either opening an issue and tagging me (@julianpoy), or commenting on an existing issue is a good idea. I may have suggestions for how to approach the problem, where one might look to implement a feature, or general guidance of how to "fit" the RecipeSage UX.

### Development

Below are some notes for getting setup to contribute code.

#### Setting-up your development environment

1. Install [Docker](https://docs.docker.com/get-docker/) and [Node](https://nodejs.org/en/)
2. Clone this repo
Expand All @@ -85,7 +103,7 @@ Setting-up your development environment.
6. Run database migrations `docker compose exec backend npx prisma migrate dev`
7. RecipeSage should be running on `localhost` on port `80`

Some notes for the repo:
#### Notes about the repo

1. The repo uses the monorepo management tool [nx](https://nx.dev/nx-api). You'll find things divided up in the `packages` directory.
2. I'm currently migrating to Prisma & TRPC, so any new functionality should be added within the `trpc` package rather than the `backend` package, unless it's an update to an existing behavior that does not merit moving.
Expand Down
2 changes: 2 additions & 0 deletions kube/configs/secrets-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ stringData:
WEBLATE_GITHUB_USERNAME: ""
WEBLATE_GITHUB_TOKEN: ""
WEBLATE_GITHUB_HOST: ""
WEBLATE_SOCIAL_AUTH_GITHUB_KEY: ""
WEBLATE_SOCIAL_AUTH_GITHUB_SECRET: ""
---
apiVersion: v1
kind: Secret
Expand Down
4 changes: 4 additions & 0 deletions kube/configs/weblate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ spec:
value: "[email protected]"
- name: WEBLATE_DEFAULT_FROM_EMAIL
value: "[email protected]"
- name: WEBLATE_DEFAULT_COMMITER_EMAIL
value: "[email protected]"
- name: WEBLATE_DEFAULT_COMMITER_NAME
value: "RecipeSage Weblate Bot"
- name: WEBLATE_ALLOWED_HOSTS
value: "*"
- name: WEBLATE_REGISTRATION_OPEN
Expand Down

0 comments on commit 5f26e4a

Please sign in to comment.