Skip to content

Bee-Keeping-App/Beekeepr

Repository files navigation

React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

Architecture Diagrams

The following diagrams can used as a visual guide to the form and function of this application. Currently a work in progress.

Below is the simplified, dependency diagram (WIP - Please Advise!).

![Dependency Architecture](assets/docs/Dependency Architecture.png)

Request Flow Diagram

This diagram models the architecture of this application during request flow. It is a blown up version of the relationship between Frontend, Backend, and Database. Not included from the simple diagram above are the supporting directories: assets (pulled by frontend exclusively), tests (pulled by backend exclusively), and ios (frontend wrapper).

(WIP - Please Advise!)

![Request Flow](assets/docs/Request Flow.png)

About

Beekeeping App developed by students in RCOS at RPI. Built using react-native for deployment. All code is open source under the MIT license

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors