{"id":20251745,"url":"https://github.com/bryce-mcmath/traderu","last_synced_at":"2026-03-09T13:01:44.633Z","repository":{"id":40726902,"uuid":"245534980","full_name":"bryce-mcmath/traderu","owner":"bryce-mcmath","description":"Stock and cryptocurrency trading simulator","archived":false,"fork":false,"pushed_at":"2023-01-24T01:44:10.000Z","size":23025,"stargazers_count":3,"open_issues_count":53,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-22T08:51:20.311Z","etag":null,"topics":["d3","express","nodejs","postgresql","typescript","vue"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryce-mcmath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-06T23:27:25.000Z","updated_at":"2024-04-15T16:34:23.000Z","dependencies_parsed_at":"2023-02-13T09:45:58.111Z","dependency_job_id":null,"html_url":"https://github.com/bryce-mcmath/traderu","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bryce-mcmath/traderu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Ftraderu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Ftraderu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Ftraderu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Ftraderu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryce-mcmath","download_url":"https://codeload.github.com/bryce-mcmath/traderu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryce-mcmath%2Ftraderu/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30297111,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T11:12:22.024Z","status":"ssl_error","status_checked_at":"2026-03-09T11:10:54.577Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["d3","express","nodejs","postgresql","typescript","vue"],"created_at":"2024-11-14T10:12:35.995Z","updated_at":"2026-03-09T13:01:44.582Z","avatar_url":"https://github.com/bryce-mcmath.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TraderU\n\n\u003e Stock and cryptocurrency trading simulator\n\n\u003c!-- Badges --\u003e\n\n![Build Status](https://codebuild.us-east-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoidkc4a2Q5UFVuTTNNRkVwTERVWnZEbGhkK0g2ZmhVdHN0cWxIS3owaDJ0TndQRHNRUmlLM2VYalhxQzFJTXkxSkFVb2JUdklHNk91aFN2ZjZQLzhTbmswPSIsIml2UGFyYW1ldGVyU3BlYyI6Im85a3kvRDF2V0JjU28vcG4iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D\u0026branch=master)\n[![codecov](https://codecov.io/gh/bryce-mcmath/traderu/branch/development/graph/badge.svg)](https://codecov.io/gh/bryce-mcmath/traderu)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\n**NOTE: To be used on mobile and tablet only, we have not yet added support for desktop**\n\nTraderU is a progressive web app (PWA) made to simulate stock and cryptocurrency trading. It utilizes several publicly available APIs to do so, most notably [AlphaVantage.](https://www.alphavantage.co/documentation/) It's a full stack application designed using a mobile-first approach, deployed with an AWS Pipeline (no longer in service unfortunately)\n\n## Table of contents\n\n- [Usage](#usage)\n- [Getting started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installing and running](#installing-and-running)\n- [Built with](#built-with)\n- [Contributing](#contributing)\n- [Meta](#meta)\n- [Known issues / bugs](#known-issues-/-bugs)\n- [Feature roadmap](#feature-roadmap)\n  - [In the works](#in-the-works)\n  - [Planned](#planned)\n- [Acknowledgements](#acknowledgements)\n\n## Usage\n\n\u003c!-- Gifs --\u003e\n\n### Demo:\n\n![Demo](https://github.com/bryce-mcmath/traderu/blob/development/docs/demo.gif?raw=true)\n\nThe above gif demonstrates our basic app flow. For more screenshots and other documentation, navigate to the /docs directory from the root of this repo.\n\n## Getting started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nIf you don't have Nodejs and npm installed, install them from [here.](https://nodejs.org/en/). You'll also want the Vue CLI tool, which you can install after you install Node like this:\n\n```sh\nnpm i -g @vue/cli\n```\n\n### Installing and Running\n\nClone this repository to your local machine and then create a .env following the .env.example file\n\n#### Install Dependencies\n\nIn the root directory:\n\n```sh\nnpm i\n```\n\n```sh\nnpm run lerna-install\n```\n\n### Available Root Commands\n\n#### Compiles and minifies both server and client for production\n\n```sh\nnpm run build\n```\n\n#### Start the compiled JS server\n\n```sh\nnpm run start\n```\n\n#### Hot TypeScript server reload for development\n\n```sh\nnpm run dev\n```\n\n#### Run unit and integration tests in both the client and server\n\n```sh\nnpm run test\n```\n\n#### Generate new docs for both the client and server\n\n```sh\nnpm run jsdoc\n```\n\n**NOTE: Our client side JSDoc comments are almost not existent, but our server should generate semi-decent ones. Browse to /docs/jsdoc/server/ and open up index.html in your browser to see the outputted documentation**\n\n### Other available Commands\n\nThere are more commands than is necessary to list here, refer to package.json files to view them.\n\n## Built with\n\n- [Vue](https://vuejs.org/) - Front-end framework, used the full suite (Vuex, Vue-Router, Vuetify etc.)\n- [D3.js](https://d3js.org/) - JS Data Visualization framework - our graphs and charts and gauges are built with this\n- [Lerna](https://www.lerna.js.org) - How we're able to run many subdirectory commands with a single root command\n- [TypeScript](https://typescriptlang.org) - Javascript superset to add type checking (Strict mode only used in server)\n- [axios](https://github.com/axios/axios) - Promise-based HTTP client\n- [Sass](https://sass-lang.com/) - CSS pre-compiler to make styling way easier\n- [JSON Web Tokens](https://jwt.io/) - For industry standard authentication\n- [Nodejs](https://nodejs.org/en/) - Javascript runtime\n- [Express](https://expressjs.com/) - Framework used for API in Node\n- [PostgreSQL](https://www.postgresql.org/) - Open source object-relational database\n- [Postman Team](https://www.postman.com/) - For testing and debugging out routes\n- [Jest](https://jestjs.io) - Testing library we used for unit and integration tests\n- [Cypress](https://cypress.io) - End-to-end testing framework we had time to add a few E2E tests with\n- [AWS](https://aws.amazon.com) - Used to deploy our app. The flow works like this: Reach a milestone stable version of development -\u003e merge to master -\u003e Github Hook triggers AWS CodeBuild -\u003e CodeBuild runs install, build, and test stages (see buildspec.yml - Lerna made this very easy) -\u003e If successful, CodeDeploy sends zipped output files to an AWS S3 bucket -\u003e Contents is served with an AWS EC2 instance via AWS Elastic Beanstalk\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/bryce-mcmath/traderu/fork\u003e)\n2. Create your feature branch (`git checkout -b feature/fooBar`) or issue branch (`git checkout -b issue/brokenThing`)\n3. Commit your changes (`git commit -m 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new PR\n\n**NOTE: We have a preferred commit message template in docs/NOTES.md if you'd like to use that as well. For tiny changes, don't worry about it**\n\n## Meta\n\nJon Langlois - [jlangy](https://github.com/jlangy) - jonathan-langlois@live.ca\n\nWilson Wong – [wilwong89](https://github.com/wilwong89) – wilwong89@gmail.com\n\nBryce McMath – [bryce-mcmath](https://github.com/bryce-mcmath) – bryce.j.mcmath@gmail.com\n\n## Known issues / bugs\n\n- Bugs? What bugs?\n\n_To add an issue, start a new one [here.](https://github.com/bryce-mcmath/traderu/issues)_\n\n## Feature roadmap\n\n### In the works\n\n- After demo day we'll get back to work on it. Well after the day after demo day. We need to catch up on sleep the day after.\n\n### Planned\n\n- General robustness, more consistent patterns and clean up\n- Use GZip with requests that recieve text-based JSON payload\n- Market close and open\n- Order duration algorithm, enable option\n- Limit orders, and associated algorithm, enable option\n- Portfolio settings toggles are permanently changed on save\n- Limit on number of accounts per user\n- Push notifications\n- An simple algorithm to generate trade suggestions, so we have something to notify users of\n- Desktop design\n- Set E2E tests to run and exit without developer input\n- More data, more and better data visualizations\n\nIn no particular order other than the first one is first\n\n_If you'd like to add a feature yourself, please see the [Contributing](#contributing) guidelines._\n\n## Acknowledgements\n\nFor making powerful services inexpensive for students:\n\n- AlphaVantage\n- ElephantSQL\n- AWS\n\nFor being Vue gurus:\n\n- Gary Jipp\n- LinusBorg on the Vue forums\n\n## ![TraderU](https://github.com/bryce-mcmath/traderu/blob/master/docs/img/logo.png?raw=true)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryce-mcmath%2Ftraderu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryce-mcmath%2Ftraderu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryce-mcmath%2Ftraderu/lists"}