https://github.com/gleennkar/react-capstone
This is a web application that allows users to view the stock details of major companies where you can either search by company's name or symbol.
https://github.com/gleennkar/react-capstone
bootstrap react reactjs redux
Last synced: 3 months ago
JSON representation
This is a web application that allows users to view the stock details of major companies where you can either search by company's name or symbol.
- Host: GitHub
- URL: https://github.com/gleennkar/react-capstone
- Owner: Gleennkar
- Created: 2022-11-28T17:55:11.000Z (over 3 years ago)
- Default Branch: Dev
- Last Pushed: 2022-12-01T10:55:06.000Z (over 3 years ago)
- Last Synced: 2024-05-17T15:25:22.282Z (about 2 years ago)
- Topics: bootstrap, react, reactjs, redux
- Language: JavaScript
- Homepage: https://super-manatee-13c6a9.netlify.app/
- Size: 2.34 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-capston
align="center">
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[stock-market-metrics]** This is a web application that allows users to view the stock details of major companies where you can either search by company's name or symbol.
## Tools & Technologies
- npm
- Gitflow
- React
- Redux
- Redux - Thunk
- Javascript Events
- React life cycle methods
- Hooks, States, Props
### Tech Stack
- Financial Modeling API
- Jest
- React Testing Library
- Linters
> Describe the tech stack and include only the relevant sections that apply to your project.
- Jest is a test library use for testing
- financial modeling api is use to extra real details which can enable stock analysis
- Linters to check for errors
Client
Server
Database
> Describe between 1-3 key features of the application.
- **[Details]**
- **[Home]**
- **[Stock]**
align="right">(back to top)
> Add a link to your deployed project.
- [Live Demo Link](https://super-manatee-13c6a9.netlify.app/)
align="right">(back to top)
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- npm install
- npm run start - To run the application locally
- Run the brower via localhost:3000
- npm run build - To build the application locally
### Setup
Clone this repository to your desired folder:
- git clone https://github.com/Gleennkar/react-capstone.git
- cd react-capstone
- git checkout dev
### Install
Install this project with:
- npm install
### Usage
To run the project, execute the following command:
- npm run start - To run the application locally
- Run the brower via localhost:3000
- npm run build - To build the application locally
### Run tests
To run tests, run the following command:
- npm test
### Deployment
You can deploy this project using:
align="right">(back to top)
> Mention all of the collaborators of this project.
## Authors
👤 **Odette gleen**
- GitHub: [@Gleennkar](https://github.com/Gleennkar)
- Twitter: [@gleeny24](https://twitter.com/twitterhandle)
- LinkedIn: [@gleeny](https://www.linkedin.com/in/gleeny-nkar-aa3917182)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page]().
align="right">(back to top)
> Write a message to encourage readers to support your project
If you like this project can give it some stars on github
align="right">(back to top)
> Give credit to everyone who inspired your codebase.
Original design idea by Nelson Sakwa on Behance.
align="right">(back to top)
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/)
align="right">(back to top)