jing1524 / fair_share

Issues

login page/onboarding

- subtitle is not readable, center the discription might be better

- Get Started and login option -> reposition them to have clearer direction for user

- onboarding process should have validation? -> better to have some necessary input field to be required

    • use context to handle formValidation logic and separate it from the component
    • might be a good idea to refactor the steps into it's own file
    • onBoarding context could be a separate file as well to keep the code clean
    • add shareholder modal should disable the ability to close when click on outside of the modal

- should FairShare logo have the ability to navigate back to home page?

- when user didn't fill out the grants info -> it shouldn't be allowed to add grant?

- cannot navigate to previous step in the onboarding process

ShareholderStep

- should user be able to chose which shareholder to add grant for?

- currently when i add multiple shareholders, the next button directs user back to home page

- the newShareholder is not being set correctly in the shareholderStep-> Add Shareholder

- update/add grant modal

    • when adding number of shares, the input field is only allowing user to type in certain number

    • with the added value per share input field, currently not able to delete the initial value 0, this applies to
      the modal that's on the shareholder page

dashboard Page

- should have logout button that directs the user back to home page

  current behavior: logout button is not navigating the user back to home page, and url is stuck on "/dashboard/investor".
  and the only way that i'm able to get back to the home page is by clearing the localstorage. and because the data was being
  cleared, there is no record of the user data.(stuck on this issue)

Current state

- Added form validation during the onboarding process

- Implemented share type, and able to view share type on the pie chart in dashboard. Also showing the share type for each shareholder on shareholder page

- Implemented share value, added share value field in company model, update the shareValue with reducer, and setting the updated
share value in local database. Allows user to set value per share during the onboarding stage(Add grant modal), also user can update the value in the shareholder page(add grant modal). Also displaying the total value per share type on the shareholder page, and marketcap on dashboard. Added ability for user to view equity value in pie chart.

Fair Share

Welcome to Admiral! We have pivoted, and now our product is an equity sharing app. We're still in MVP phase, and are excited for our new hires to help build our app.

Frontend

The frontend of the application is a React application that uses context and React Query to manage state.

You can find documentation for these here: https://reactjs.org/docs/context.html https://react-query.tanstack.com/

Importantly, there are two key conepts for React Query: mutations and queries. When you want to update data, you use a mutation. When you're just referencing data, you use a query.

The application is broken up into a few main areas:

Styles

We use chakra for our component library. We really like it! Please use it for new UI features.

https://chakra-ui.com/docs/getting-started

Testing

We use Jest and Testing Library to write our tests. So far we have okay tests, but they're not perfect. We're always looking for improvement, but we do require that new features include tests!

https://jestjs.io/ https://testing-library.com/docs/react-testing-library/intro

Structure

Onboarding

This portion of the app contains components for all of the steps in the onboarding process

Dashboard

The dashboard contains company and aggregated metrics which show how ownership is broken down across all shareholders.

Shareholder

The ShareholderPage contains data specific to a just a single shareholder, and shows how much equity they have.

Today, the app allows basic create operations but isn't great for updates (or other operations). We need your help to improve this functionality.

Backend

We're saving server expenses by mocking all network calls using MSW. You don't need to understand what MSW is, other than that we use it to define handlers for outgoing network calls. No servers === no problems.

The behavior of our "backend" is defined by the "handlers" in handlers.ts. If you need to make changes or add endpoints, this is where you can do this.

You probably don't need to worry about our database--its just some objects in memory on the user's browers. Its genius, right?

Getting Started with Create React App

This project was bootstrapped with Create React App.

Yarn

If you don't have yarn, please install it by running

npm install --global yarn

Installing dependencies

Installing dependencies with yarn is easy. Simply run it in the base directory without any arguments, and it will get you what you need.

yarn

Available Scripts

In the project directory, you can run:

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.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Fair-share

Fair-share

fair_share