TradeByte

KO | EN

gitlite — search

#php #java #ruby #python #javascript #hacktoberfest #wordpress #nodejs #shell #c-plus-plus #logging #android

★ 35 Open GitHub ↗

💸 TradeByte - Stocks Trading Simulation WebApp ( ⚠️ NOT ACTIVELY MAINTAINED )

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ⚠️ NOT ACTIVELY MAINTAINED

---

# <img src="public/images/TradeByte-Favicon.png" alt="logo" width="30"/> **TradeByte**

## Stocks Trading Simulation WebApp

![Stars](https://img.shields.io/github/stars/iampavangandhi/TradeByte?color=2948ff&label=Stars&style=flat-square) ![Forks](https://img.shields.io/github/forks/iampavangandhi/TradeByte?color=2948ff&label=Forks&style=flat-square) ![Contributors](https://img.shields.io/github/contributors/iampavangandhi/TradeByte?color=2948ff&label=Contributors&style=flat-square) ![Issues](https://img.shields.io/github/issues/iampavangandhi/TradeByte?color=2948ff&label=Issues&style=flat-square) ![Pull Requests](https://img.shields.io/github/issues-pr/iampavangandhi/TradeByte?color=2948ff&label=Pull%20Requests&style=flat-square)

![License](https://img.shields.io/github/license/iampavangandhi/TradeByte?color=2948ff&label=License&style=flat-square) ![Language](https://img.shields.io/github/languages/top/iampavangandhi/TradeByte?color=2948ff&label=Language&style=flat-square) ![Lines of Code](https://img.shields.io/tokei/lines/github/iampavangandhi/TradeByte?color=2948ff&label=Lines%20of%20Code&style=flat-square) ![Version](https://img.shields.io/github/package-json/v/iampavangandhi/TradeByte?color=2948ff&label=Version&style=flat-square) ![Deployment](https://img.shields.io/github/deployments/iampavangandhi/TradeByte/tradebyte?color=2948ff&label=Deployment&style=flat-square) ![Repo Size](https://img.shields.io/github/repo-size/iampavangandhi/TradeByte?color=2948ff&label=Repo%20Size&style=flat-square)

## Website : https://tradebyte.up.railway.app

[![Project Board](https://img.shields.io/badge/-Project%20Board-0e76a8?style=for-the-badge&logo=Github&logoColor=white)](https://github.com/iampavangandhi/TradeByte/projects/1) [![Project Wiki](https://img.shields.io/badge/-Project%20Wiki-283c86?style=for-the-badge&logo=wikipedia&logoColor=white)](https://github.com/iampavangandhi/TradeByte/wiki) [![Project Report](https://img.shields.io/badge/-Project%20Report-3b5998?style=for-the-badge&logo=google-sheets&logoColor=white)](https://docs.google.com/spreadsheets/d/1_vg-F2dk6jWy9jcYlGuKqAnXUX6NwbbnLg9Bmn_Ulrk/edit?usp=sharing) [![TheNodeCourse](https://img.shields.io/badge/-TheNodeCourse-11998e?style=for-the-badge&logo=node.js&logoColor=white)](https://github.com/iampavangandhi/TheNodeCourse)

</div>

---

## Table of Contents

- [**TradeByte**](#img-srcpublicimagestradebyte-faviconpng-width30-tradebyte)
  - [Tech Stack](#tech-stack)
  - [Config Setup](#config-setup)
  - [Build Setup](#build-setup)
  - [Folder Structure](#folder-structure)
  - [Contributing](#contributing)
  - [Contributors](#contributors)
  - [Maintainers](#maintainers)
  - [API Credits](#api-credits)
  - [License](#license)

## Tech Stack

## Config Setup

#### Add following keys into the `config.env` file. These all are free to use keys.

- [MongoDB URI](https://www.mongodb.com/cloud/atlas)
- [Alpha Vantage Keys](https://www.alphavantage.co/)
- [Google OAuth Credentials](console.developers.google.com/)
- [GMAIL API Credentials](https://www.woolha.com/tutorials/node-js-send-email-using-gmail-with-nodemailer-oauth-2)
- [Stripe Payment Gateway Keys](https://stripe.com/)

#### Make sure to use the same `config.env` format given below.

```bash
PORT = XXXX
MONGO_URI = XXXX
ALPHA_VANTAGE_KEY = XXXX

GOOGLE_CLIENT_ID = XXXX
GOOGLE_CLIENT_SECRET = XXXX

GMAIL_ADDRESS = XXXX
GMAIL_OAUTH_CLIENT_ID = XXXX
GMAIL_OAUTH_CLIENT_SECRET = XXXX
GMAIL_OAUTH_REFRESH_TOKEN = XXXX
GMAIL_OAUTH_ACCESS_TOKEN = XXXX
GMAIL_OAUTH_TOKEN_EXPIRE = XXXX

PK_TEST = XXXX
SK_TEST = XXXX

```

## Build Setup

```bash
# install dependencies
npm install

# run in production
npm start

# run in development
npm run dev
```

## Folder Structure

.
    ├── 📁 .github                 # Github files (don't change)
    ├── 📁 config                  # Configuration files
    ├── 📁 helpers                 # Helper or Controller files
    ├── 📁 middleware              # Express middleware
    ├── 📁 models                  # Mongoose models
    ├── 📁 project-plan            # Project planning files
    │   └── 📁 ui-designs
    ├── 📁 public                  # Public folder
    │    ├── 📁 css
    │    ├── 📁 images
    │    └── 📁 javascript
    ├── 📁 routes                  # Express routes
    │    └── 📁 api
    └── 📁 views                   # EJS views
         ├── 📁 error
         ├── 📁 layouts
         └── 📁 partials

## Project Plan

![Project Plan](https://raw.githubusercontent.com/iampavangandhi/TradeByte/master/project-plan/TradeByte.jpg)

## Contributing

Feel free to dive in! [Open an issue](https://github.com/iampavangandhi/TradeByte/issues/new) or submit PRs.

See the [CONTRIBUTING.md](CONTRIBUTING.md) for details. Kindly follow the [Code Of Conduct](CODE_OF_CONDUCT.md)

## Contributors

This project exists thanks to all the people who contribute.

[![Contributors](https://readme-contributors.now.sh/iampavangandhi/tradebyte?extension=jpg&width=300&avatarSize=25)](https://github.com/iampavangandhi/TradeByte/graphs/contributors)

## Maintainers

#### This repo is maintained by [Pavan Gandhi](https://github.con/iampavangandhi).

## API Credits

### [Alpha Vantage](https://www.alphavantage.co/)

## License

---

### Show some ❤️ by starring the repository!

</div>

TradeByte

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README