Table of Contents
Tech Stack
Config Setup
Add following keys into the config.env file. These all are free to use keys.
- MongoDB URI
- Alpha Vantage Keys
- Google OAuth Credentials
- GMAIL API Credentials
- Stripe Payment Gateway Keys
Make sure to use the same config.env format given below.
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
# install dependencies
npm install
# run in production
npm start
# run in development
npm run devFolder 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
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.
Maintainers
This repo is maintained by Pavan Gandhi.
API Credits
Alpha Vantage
License
MIT © Pavan Gandhi