Skip to content

Commit

Permalink
frontend: add CI/CD and frontend patterns docs
Browse files Browse the repository at this point in the history
  • Loading branch information
horacioh committed Sep 2, 2023
1 parent 4c601cc commit 4f6f415
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/docs/ci.md
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















11 changes: 11 additions & 0 deletions docs/docs/frontend-code-patterns.md
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)

0 comments on commit 4f6f415

Please sign in to comment.