Wall Street Blast Front-End

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Workflow
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

Wall Street Blast is a mobile gambling application that simulates the ups and downs of the stock market.

(back to top)

Built With

The wall-street-blast-frontend Repo is the front-end repository for the Wall Street Blast online gambling application.

This application is built using:

• 
• 
• 
• 
• 

(back to top)

Getting Started

Wall Street Blast is a lightweight mobile application with a few dependencies.

Prerequisites

First, install the latest version of npm:

• npm

  npm install npm@latest -g

Installation

1. Clone the repo:

   git clone [email protected]:rashadnm01/wall-street-blast-frontend.git

2. Install NPM packages:

   npm i

3. Install Dependencies:

   npm i @commitlint/cli

   npm i @commitlint/config-conventional

   npm i @testing-library/jest-dom

   npm i @testing-library/react

   npm i @testing-library/user-event

   npm i chart.js

   npm i chartjs-plugin-datalabels

   npm i cross-env

   npm i react

   npm i react-bootstrap

   npm i react-chartjs-2

   npm i react-dom

   npm i sass

   npm i scss

   npm i web-vitals

   npm i react-app-rewired

(back to top)

Roadmap

• Add Changelog
• Front-End Design
  • Navigation Bar
  • Marquee
  • Blast
  • Menu Bar
  • Money Menu
  • Open Position Button
• Back-End Design
  • Authentication: Username/Email/Password -> OAuth
  • User Data
    • Username
    • Password
    • Avatar
    • Bankroll
    • Financial API/Data
    • Game History
  • Game Logic
  • CRUD
    • Lifetime Earnings (PNL)
    • Create User
    • Read User Info
    • Update User Info
    • Delete User
  • Basic QA: Testing Framework -> Jest
  • Multiplayer Functionality
  • SQL Security -> Prevent injections
  • State Changes/Event Handling
  • [] The ability to start and end games

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Rashad - [@RashadNAli] (https://twitter.com/RashadNAli) - [email protected] Matty - @MattyBCodes - [email protected]

Project Link: Wall Street Blast

(back to top)

Acknowledgments

Here are some useful resources to get started.

• Live Site
• Project Repo
• Figma
• Trello
• Conventional Commits Guidelines

(back to top)