ajibs / stock-master

Stay updated with the stock trends of companies you and friends care about.

Stock Master

Stay updated with the stock trends of companies you and friends care about.

Stock Master is a FreeCodeCamp Project.

Feature List

• View graph displaying the recent trend lines for each added stock.
• User can add new stocks by their symbol name.
• User can remove stocks.
• See changes in real-time when any other user adds or removes a stock.

Getting Started

Stock Master is hosted on Heroku and can be accessed here:

• Production

Prerequisites

These are what you need installed on your computer to use the application:

• Web Browser (Chrome, or Mozilla, or Safari, or Opera, or Microsoft Edge )

For Developers:

• Git
• Node.js
• MongoDb
• Yarn

Setup

Local Copy

To create a local copy, run the following in your terminal:

git clone https://github.com/ajibs/stock-master.git

Then change into the local directory, run the following in your terminal:

cd stock-master

Install Node.js and Yarn

If you don't have Node.js installed, please go ahead and grab it here. This project uses ES6+ features and requires Node version >= 7.6.0 and <=8.9.1

Yarn is a package manager for Node.js and can be installed from here.

To confirm that you have Node.js installed, run the following in your terminal:

node -v

You should get something like v8.9.1.

To confirm that you have Yarn installed, run the following in your terminal:

yarn -v

You should get something like 1.3.2.

Setup Database and .env file

You can setup a database on mlab. You should also create a .env file using .env.sample as a prototype.

Install Node.js Modules

To install all dependencies, run the following in your terminal:

yarn

Development

To kickstart the application, run the following in your terminal:

npm start

To continue full-stack development on this project, run the following in your terminal:

npm run dev

Built With

• Git - Version Control
• Node.js - JS Runtime Environment
• Yarn - Package Manager
• Express - Web Framework
• Pug - Templating Engine
• Webpack - Build Tool
• Babel - Transpiler
• mLab - Database
• Heroku - Hosting and Continuous Deployment
• VS Code - Code Editor
• Chrome - Browser

Contributing

Contributions are welcome

Author

• Bolu Ajibawo

License

MIT

Acknowledgments

• Vadym Yatsyuk
• FreeCodeCamp
• Chingu
• Red Pandas
• Developer Community
• Family and Friends