cshg / investjs

#InvestJS Personal portfolio management tool to visualize and monitor different investment strategies

Table of Contents

1. Getting started
2. Tech
3. Directory Layout
4. Contributing

Getting started

Clone and install dependencies:

$ https://github.com/cshg/investjs.git
$ cd investjs
$ npm install

$ npm start

Tech

Frontend:

• AngularJS
• Angular UI-Router
• Chart.js

Backend:

• Node.js
• Express.js
• nodemailer
• MongoDB

Directory Layout

├── /node_modules/              # 3rd-party libraries and utilities
├── /client/                    # Client Angular Entry Points
│   ├── /app/                   # Main application folder
│   │   └── app.js              # Main application entry point
│   │   └── portfolio.html      # Portfolio html view
│   │   └── portfolioCtrl.js    # Portfolio controller functions
│   │   └── savePopup.html      # Popup html view
│   ├── /assets/                # Static assets to be served
│   ├── /bower_components/      # 3rd-party libraries and utilities
│   └── savePopup.html          # Express application entry point
├── /server/                    # Server source
│   └── portfolioController.js  # Controller functions for incoming requests
│   └── portfolioModel.js       # Database interactions
│   └── requestHandler.js       # Incoming request routing
│   └── server.js               # Express application entry point
└── bower.json                  # bower dependencies, scripts, and package info
└── package.json                # npm dependencies, scripts, and package info

Contributing

1. Fork the repo.
2. Clone it to your local computer
3. Cut a namespaced feature branch from master and name it appropriately
4. Make commits and prefix each commit with the type of work you were doing
5. BEFORE PUSHING UP YOUR CHANGES, rebase upstream changes into your branch, fix any potential conflicts, and then push to your fork.
6. Submit a pull request directly to the master
7. Someone else will perform code review to keep codebase cleanFix any errors or issues raised by the reviewer and push 4he fixes as a single new commit Repeat until the pull request is merged.