Skip to content

leevilehtonen/stockfolio-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Dependency Status License: MIT

Node web app for managing your stock portfolio (client)

  • Live demo - Live demo username: tester, password: 123456
  • Help - create-react-app user guide
  • Components - more information about react components used
  • Hours - Working hours at Google Sheets

NOTE: As Yahoo updated their finance API to v10, there is currently some issues retrieving the data, Stockfolio is depending on yahoo-finance as data provider and people are working to get the module functional.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

  • Node.js - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Stockfolio-server - Backend for stockfolio server running either locally or at some host

Installing

A step by step series of examples that tell you have to get a development env running

git clone https://github.com/leevilehtonen/stockfolio-client.git //or with ssh
cd stockfolio-client
npm install
npm start // runs project in development mode in local development server

NOTE: To be able to connect to your own stockfolio-server you need to change API_URI variable at /utils/api.js depending on your server adress

npm run build // creates production build

Running the tests

npm install
npm test

Deployment

For building production ready app:

npm install
npm run build 

If you want to deliver your own copy of stockfolio, it's very easy to serve at Firebase, see more docs at firebase website

Built With

Dependencies

Dev Dependencies

  • react-docgen-readme: CLI tool that extracts information from React Components using react-docgen, transforms that information into Markdown and adds it to your README file.
  • react-scripts: Configuration and scripts for Create React App.

Contributing

Make merge ready PR or contact me with feature suggestions.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments