chrisleee / twitch-stocks

A web platform that allows you to invest in Twitch streamers with imaginary points.
GNU General Public License v3.0
21 stars 8 forks source link
jest mongodb nextjs react stocks styled-components twitch twitch-stocks typescript

Twitch Stocks

Build Status Coverage Status Commitizen friendly

Twitch Stocks allows you to invest in Twitch streamers using virtual points. (No money involved)

Say your favorite streamer averages 20,000 viewers one week and you invest in them. The next week they managed to bump their average viewer count to 22,000. You just profited! Maybe you're feeling risky and want to invest in a low-viewer streamer in the hopes that they blow up in viewership.

Everything, such as using viewer count as value, is tentative at this point.

Live Site

Come check out the live site: https://twitch-stocks.now.sh/

Note: This project has been abandoned.

If you are looking for a Twitch Stock trading app, check out the unaffiliated site: https://twitchstocks.com


Development

Getting Started

Firstly, check out the project's Roadmap and issues.

  1. Install Node.js.

I recommend using Node Version Manager: Linux/macOS Windows

  1. Fork the repo.

  2. Clone the project.

git clone https://github.com/ChrisALee/twitch-stocks.git
  1. Navigate to the directory (twitch-stocks by default).
cd twitch-stocks
  1. Choose one of the three directories to work on and follow from step 4:

Client

Server

Twitch

Note to those on Windows:

The build scripts require the use of linux console emulators such as cmder, cygwin or Bash on Ubuntu on Windows. Simply install one of the above then run npm run dev as usual in the console emulators instead of cmd or powershell.

Any contributions are appreciated.

For details on how to contribute (code style and more) please visit our contributing guidelines.

Check out the issues tab for our project's TODO's, bugs, and questions.

The same information can also be found on the project page.


Learning Resources

Next.js:

React:

Node.js/Express:

MongoDB:

TypeScript:

Testing Frameworks:

Jest:
Enzyme:
SuperTest:

Join us on Discord #twitch-stocks!

Please be sure to ask any questions if you get stuck on anything related to the project or languages used. We're all learning here, and teaching is a great way to reinforce concepts.


Bug / Feature Request

If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.

If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.


Built With

Contributors

Thank you to:

We are definitely open to having anyone help and contribute.

Check out this spreadsheet and add your name!

And, once again, come chat with us on Discord #twitch-stocks!