-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
frontend: add CI/CD and frontend patterns docs
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# CI | ||
|
||
## TLDR; | ||
|
||
- This repo is a Multi-Language repo. | ||
- We use Nix & Bazel to manage project dependencies | ||
- We use direnv to load all environment varialbes needed on the project | ||
- For the frontend projects we use Yarn Workspaces. | ||
- Currently we have 2 projects: Desktop app and Sites | ||
- the Desktop app is built entirely on Github actions | ||
- Sites are built as a Docker container for easy deployment | ||
- We create a new release of both projects every Tuesday in the morning automatically | ||
- If we need to create a new release manually, we need to push a tag to the `master` branch and the process will start. | ||
- version numbers follow the next pattern: `<YEAR>.<MONTH>.<NTH_COMMITS_ON_MONTH>` | ||
- We run validation code (lint, format and test) on every push to `master` and on every PR | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Frontend code patterns | ||
|
||
This file aims to show all the frontend code patterns we (try!) to follow throughout all the application. This tries to cover the best practices that suits us based on the technology and tools we chose to use in the app. | ||
|
||
> This is a Living document, so things are in constant change. | ||
## Data Fetching | ||
|
||
### Prefer a data-first approach | ||
|
||
- because we are using `@tanstack/query`, there are situations in which we can have both `errors` and `data` at the same time, so [it is recommended](https://tkdodo.eu/blog/status-checks-in-react-query) in the [community resources](https://tanstack.com/query/v4/docs/react/community) |