Skip to content

Latest commit

 

History

History
105 lines (74 loc) · 4.38 KB

README.md

File metadata and controls

105 lines (74 loc) · 4.38 KB

logo TradeByte

Stocks Trading Simulation WebApp


TradeByte Project Board: Here

TradeByte Project Excel Sheet: Here

Table of Contents

Tech Stack

javascript mongodb nodejs express ejs tailwind-css google passport heroku

Build Setup

Add your MongoDB URI, Google OAuth credentials and Alpha Vantage Keys to the config.env file see config.env.example for details.

# install dependencies
npm install

# run in production
npm start

# run in development
npm run dev

Folder Structure

.
├── 📁 .github                 # Github files (don't change)
├── 📁 config                  # Config files
├── 📁 helpers                 # Helper on controller files
├── 📁 middleware              # Expresss middlewares
├── 📁 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

Contributing

Feel free to dive in! Open an issue or submit PRs.

See the CONTRIBUTING.md for details. Kindly follow the Code Of Conduct.

Contributors

This project exists thanks to all the people who contribute.

Contributors

Maintainers

Pavan Gandhi

This repo is maintained by Pavan Gandhi.

API Credits

alpha-vantage

License

MIT © Pavan Gandhi