Skip to content

Latest commit

 

History

History
195 lines (145 loc) · 7.15 KB

README.md

File metadata and controls

195 lines (145 loc) · 7.15 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Trading App

A trading app to emulate real world stock exchange with prices updating every minute and a leaderboard to decide the winner.
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License

About The Project

Product Name Screen Shot

This repo only contains the backend to support the transactions, updates in prices and news, leaderboard and other portfolio management.

After the user has been authenticated via Auth0 (whitelisted), they are initialized with a predefined amount of currency. Once the event begins, a floating timer starts counting down to 0s from 60s after which an update in news and prices takes places. User predict the price updates based on the news. Every round also has a limit on the maximum quantity that can be purchased.

After every round the leaderboard is also updated.

Architecture

arch-img

(back to top)

Built With

  • Strapi

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • yarn 
    npm install --global yarn

Installation

  1. Set up a billing account on GCP.
  2. Clone the repo 
    git clone https://github.com/aarav22/trading-app-backend.git
  3. Install NPM packages 
    yarn install
  4. Enter your API Keys in .env

(back to top)

Images

product shot 1 product shot 2

(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)