acquity 

A marketplace to buy and sell stocks from private companies or startups. Acquity equity.

This project was bootstrapped with Create React App.

Table of contents

• Get started
• Project structure
  • Rules when creating a new React component
• React hooks exposed by the app
  • useAuth
  • useUser

Get started

Environment Variables

This project uses environment variables. Before running the application with yarn start, make sure there is a .env or .env.local file in the root directory containing the following keys:

REACT_APP_BACKEND_API=<Your backend url here>

We do not recommend using our production API backend URL when building locally (since there will be contamination of data), and recommend running our backend server locally on your machine and pointing the environment variable to the local URL.

You can find and build our backend server in our acquity/api repository.

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.

Project structure

The current project structure and its important directories are shown below:

acquity
└─public/
└─src/
  │ index.js    
  │ serviceWorker.js
  └─app/
  └─assets/
  └─components/
  └─constants/
  └─contexts/
  └─reducers/
  └─routes/
  └─services/
  └─utils/

Rules when creating a new React component

This project creates a new folder for each component in its most sensible parent directory.

• For example, a component such as the Navbar that is used by multiple other components can exist in the components/ folder.

• Subcomponents that make up a single component should be grouped in the same folder.

  • E.g. LoginForm.jsx should be grouped with Login.jsx in the login/ folder.

• A component that is only used by a single other component should exist in a subfolder of the parent component.

  • E.g. the auth/login/, auth/signup/, auth/forgot-password/ folders.

• Components wrapped by React Router's <Route> object should be contained in the routes/ folder.

A typical component folder should look like this:

component
│ Component.jsx  # A stateless/function component
│ Component.scss  # The styles for the component with the same name
| ComponentContainer.jsx  # The stateful component for the stateless component it contains
| index.js  # A single line file that exports the top level component for use.

Grouping the components this way allows for easy refactoring of components without having to change all imports for other components that uses the refactored component, since one just needs to update the exported component in index.js.

The bare minimum that a component folder should contain is Component.jsx and index.js. The rest are optional.

app/ directory

Contains:

• App.js, the entry point of the application.
• rootReducer.js, for Redux store.

assets/ directory

Contains our animations, images, and our general scss folders.

components/ directory

Contains components that are used by more than 1 (or 2) components.

constants/ directory

Contains constants that are used throughout the application. Make sure to group constants in their own files according to context.

contexts/ directory

Contains contexts providing React hooks and providers that can be used by React components. See React Context for more details on how to use them.

reducers/ directory

Contains reducers used in the application. We use Redux Toolkit as our redux library of choice.

routes/ directory

Contains folders containing components that are wrapped by React Router's <Route> in src/app/AuthenticatedApp or src/app/UnauthenticatedApp.

services and utils directory

Self explanatory.

Might be merged together in the future.

React hooks exposed by the app

These hooks are exported from the various contexts/*context files in the contexts folder.

useAuth

Useful authentication functions.

import { useAuth } from 'contexts/authContext';

Contains:

• data: The current user logged in
• login(form: {email: string, password: string}): used to log in with the given form.
• register(form: {email: string, password: string, fullName: string}): used to register with the given form.
• logout(): log out of the application

Usage

const { logout } = useAuth()

<Button onClick={logout} />

useUser

Retrieve user information.

import { useUser } from 'contexts/userContext';

Usage

// App.js
const App = () => {
  const user = useUser();

  return user 
      ? <AuthenticatedApp /> 
      : <UnauthenticatedApp />
};

useSocket

Retrieve socket used for chat.

import { useSocket } from 'contexts/socketContext';

Usage

const socket = useSocket();
const sendMessage = () => {
    SocketRequestService.addNewMessage({
      ...
      socket
    });
};