13db1bd0a6
* Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review * updated contributing.md * fixed broken links & added missing links in doc, improved structure * fixed link in wsl setup * fixed server link, added https cloning in yarn-setup * removed package-lock.json * added doc card, admonitions * removed underline from nav buttons
53 lines
1.5 KiB
Plaintext
53 lines
1.5 KiB
Plaintext
---
|
|
title: Overview
|
|
description: Overview
|
|
sidebar_position: 0
|
|
sidebar_custom_props:
|
|
icon: TbEyeglass
|
|
---
|
|
|
|
## Tech Stack
|
|
|
|
We took care of having a clean and simple stack, with minimal boilerplate code.
|
|
|
|
**App**
|
|
|
|
- [React](https://react.dev/)
|
|
- [Apollo](https://www.apollographql.com/docs/)
|
|
- [GraphQL Codegen](https://the-guild.dev/graphql/codegen)
|
|
- [Recoil](https://recoiljs.org/docs/introduction/core-concepts)
|
|
- [TypeScript](https://www.typescriptlang.org/)
|
|
|
|
**Testing**
|
|
|
|
- [Jest](https://jestjs.io/)
|
|
- [Storybook](https://storybook.js.org/)
|
|
|
|
**Tooling**
|
|
|
|
- [Yarn](https://yarnpkg.com/)
|
|
- [Craco](https://craco.js.org/docs/)
|
|
- [ESLint](https://eslint.org/)
|
|
|
|
## Architecture
|
|
|
|
### Routing
|
|
|
|
We use [React Router](https://reactrouter.com/) for routing.
|
|
|
|
To avoid unnecessary [re-renders](/contributor/frontend/advanced/best-practices#managing-re-renders) we handle all the routing logic in a `useEffect` in `PageChangeEffect`.
|
|
|
|
### State Management
|
|
|
|
We use [Recoil](https://recoiljs.org/docs/introduction/core-concepts) for state management.
|
|
|
|
See our [best practices](/contributor/frontend/advanced/best-practices#state-management) for more managing state.
|
|
|
|
## Testing
|
|
|
|
We use [Jest](https://jestjs.io/) for unit testing and [Storybook](https://storybook.js.org/) for component testing.
|
|
|
|
Jest is mainly used for testing utility functions, and not components themselves.
|
|
|
|
Storybook is used for testing the behavior of isolated components, as well as displaying our [design system](/contributor/frontend/basics/design-system).
|