Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carloshs1994/market-overview
Market Overview is a website designed to showcase the US stock market. You could find details about the stock of choice and improve your strategies. Built using React, Redux, SASS, and tested using React testing library.
https://github.com/carloshs1994/market-overview
axios-react jest-mocking react reactjs redux rest-api sass
Last synced: 9 days ago
JSON representation
Market Overview is a website designed to showcase the US stock market. You could find details about the stock of choice and improve your strategies. Built using React, Redux, SASS, and tested using React testing library.
- Host: GitHub
- URL: https://github.com/carloshs1994/market-overview
- Owner: carloshs1994
- Created: 2022-03-05T11:19:09.000Z (almost 3 years ago)
- Default Branch: development
- Last Pushed: 2022-03-20T01:55:45.000Z (almost 3 years ago)
- Last Synced: 2025-01-10T07:46:50.980Z (17 days ago)
- Topics: axios-react, jest-mocking, react, reactjs, redux, rest-api, sass
- Language: JavaScript
- Homepage:
- Size: 12 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Market Overview
> Market Overview is a website designed to showcase the US stock market. You could find details about the stock of choice and improve your strategies. Built using React, Redux, SASS, and tested using React testing library.
## Built With
- React, Redux, SASS
- Visual Studio Code.
## Live Demo
- [Live Demo Link github](https://carloshs1994.github.io/market-overview/)
## Getting Started
To get a local copy up and running follow these simple example steps.
- Clone this repository with git clone```[email protected]:carloshs1994/market-overview.git``` using your terminal or command line.
- Change to the project directory by entering :
```cd market-overview``` in the terminal
### Prerequisites
You need to make sure to have installed the latest version of Node.js and npm on your computer.
> To check run `node -v`, then `npm -v` and if you get a number it means you have them.
### Install
After clone it and before working on it, you have to run ```npm install``` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include webpack and linters checks, for which you have to either generate your own config file or get one.
Note: If you're a Microverse's Student, you should use the config files provided by the program.
[Linters Config React-Redux](https://github.com/microverseinc/linters-config/tree/master/react-redux)
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) template.
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Usage
You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below
### Run linters checks
Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.
### Deployment
The deployment can be found in the Github Pages of this repository or through the link provided above
## Author
👤 **Carlos Herver Solano**
- GitHub: [@carloshs1994](https://github.com/carloshs1994)
- Twitter: [@hscarlos_](https://twitter.com/hscarlos_)
- LinkedIn: [Carlos HS](https://www.linkedin.com/in/carloshs94/)
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to Microverse.
- Inspiration [Nelson Sakwa in Behance](https://www.behance.net/sakwadesignstudio)
## 📝 License
This project is [MIT](./MIT.md) licensed.