/fantasymarket-app

YOUR road to success in the stock market!

Primary LanguageJavaScript

FantasyMarket

Website Website netlify codecov Security Headers Mozilla HTTP Observatory Grade Maintainability

YOUR road to success in the stock market


Introduction

We are creating a working stock market simulation, where the user can invest in-game currency in a simulated market completely separated from the real world. By providing custom events that pop up randomly and alter the course of our stocks, coupled with a market that never sleeps, we are presenting a fun and fast-paced introduction into the stock market.

This repo only contains the frontend, the backend is available at fantasymarket/fantasymarket-api.

Check out our documentation for more information!

Repo Structure

fantasymarket-app
├── components # reusable react components
├── docs       # documentation
├── pages      # page components
├── utils      # utility functions
├── api        # api/state management
├── tests      # tests
│   ├── e2e           # e2e tests (including automated screenshots)
│   ├── integration   # integration tests
│   └── unit          # unit & snapshot tests
└── public     # static files

Getting started

1. Install Requirements

2. Clone Repo

$ git clone https://github.com/fantasymarket/fantasymarket-app.git && cd fantasymarket-app

3. Install Dependencies

$ yarn

Development

Run development Version

$ yarn dev

Generate Static HTML

$ yarn deploy
# output: ./out/

API Server

To run the API server, check out the documentation of fantasymarket-api

Recommended Tools

  • VSCode (Recommended):
    • EditorConfig, ESLint, Babel Javascript
  • Atom:
    • language-babel, linter-eslint, editorconfig, autocomplete-modules