Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 2.02 KB

README.md

File metadata and controls

110 lines (70 loc) · 2.02 KB

Catalogue of Statistics

Global Stock is a catalogue of companies on the stock market. The project consists of a frontend application that displays financial information from an API, and stores it in the Redux store. The main features of this app are:

  • Ability to display a list of companies
  • Filter companies stocks according to categories
  • Access the details of each company

Home Page

home

Company Page

company

Built With

  • JavaScript(ES6)
  • React.JS
  • gh-pages
  • Node.js
  • Bulma
  • prop-types
  • Jest
  • Enzyme
  • Stock API: financialmodeling

Live Version

You can click on this link

Getting Started

Prerequisites

To get started open the directory where you will save this repo by typing on your terminal:

$ cd <directory>
  • Clone the repo typing:
$ git clone git@github.com:brugobi/stock-react-capstone.git
  • Install dependencies:
$ npm install
$ npm install dotenv
  • in the root create a file called .env and add:
REACT_APP_STOCK_API_KEY=your API key

Usage

  • Sfter set up the API key you can start the React server:
$ npm start

Test

  • To run the tests:
$ npm test

Author

👤 Bruna Gobi

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project! Feel free to check the issues page.

Acknowledgments

📝 License

This project is MIT licensed.