TruPaid is a automation for sharing. Roommates, tenants, landlords, and couples can share track or split bills together.

Available Scripts

In the project directory, you can run:

yarn lint

Runs typescript project files through a linter.

yarn format

Attempt to lint and fix typescript project files using prettier.

yarn start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information.

Folder Structure

┣ api/                   # Centralizes API calling based on data type
┃ ┣ api.ts
┃ ┣ index.ts
┃ ┗ user.ts
┣ assets/                # Handles images and theming support
┃ ┣ images/
┃ ┗ theme/
┣ components/            # Collection of UI components like button, custom input field, modal, etc that will be shared and used across files in the project.
┣ features/              # Each folder exports and handles it's own routes. Can be nested and have it's own components folder to be used by child routes.
┃ ┗ Onboarding/
┃   ┣ AccountCreation/
┃ ┃ ┃ ┣ Astra/
┃ ┃ ┃ ┣ Plaid/
┃ ┃ ┃ ┣ Register/
┃ ┃ ┃ ┗ index.tsx
┃   ┣ components/
┃   ┗ index.tsx
┃ ┣ components/
┃ ┗ index.tsx
┣ hooks/                # Reusable hooks. Mainly unused, but when you need it you will know.
┃ ┗ store.ts
┣ store/                # Each slice handles it's own actions, reducers, and selectors. Each slice is specific to a single resource.
┃ ┣ index.ts
┃ ┗ usersSlice.ts
┣ types/                # Typescript types and interfaces. Props types are the only exemption. They get declared above the components themselves.
┃ ┣ entities/
┃ ┣ request/
┃ ┗ response/
┣ utils/                # Files in the utils folder should only contain some functions like date formatting, string conversion, etc.
┗ index.tsx

Technolgies and resources


View Github