team-hack / stockapp

Clone of the Robinhood Stock App for fun
6 stars 4 forks source link

Stock App

The stock app is a clone of the Robinhood app. We are making this because we like the UI of Robinhood and want to try building this ourselves.

Additionally:

Database (Entities / Model)

See diagram: UML

Endpoints (Controller)

URL Purpose CRUD Operations Supported
/ Dashboard (Home)
/signup GET & POST
/signin GET & POST
/messages GET
/message POST
/message/{id} GET,POST,UPDATE,DELETE
/users See all users *
/stocks See all stocks *

...

Services (Plugin)

Views

Concepts

Too Early Demo Repo

Figma Design

Naming Files & Conventions

When creating a component, be sure to follow this file and folder structure within src/components.

src/
 | components/
    | MyComponent/
    |   tests/
    |    | MyComponent.test.tsx
    | MyComponent.tsx
    | MyComponentStyled.tsx
    | index.tsx

Getting Setup

Installing SSH

First step make sure you have a ssh key. If you are unsure you can use this tutorial to get you started.

Next run the following commands in your terminal:

$ git clone git@github.com:team-hack/stockapp.git
$ cd stockapp
$ npm install
$ npm start

You should now be able to preview the stock app at: http://localhost:3000/