Project Briefing | Technical Requirements | Architecture, Data Management and Quality Control | Live Demo Link | Installing | Built With | Author
This project is the React & Redux Capstone Project required for completing the React & Redux module at Microverse.
The capstone project is performed under time restrictions and presents business-like specifications to be followed. The goal is to simulate as much as possible the real conditions of business situations and practice professional execution.
The specifications of this project can be found in the Catalogue of Dog Clothes.
The original specification and design for the project followed those of Denys Chagaida's 'Pimp My Dog Online Store', however, it is not required to follow the design and we are supposed to change the theme of the project. I chose to make a catalog of stocks so I could have a grasp on the subject of finance, in which I'm interested.
The provided requirements stated that we must build the page with at least two types of pages:
- One page where all the displayed items could be filtered via given parameters
- A second page for the item details
Additionally, our app must collect data externally using asynchronous API calls.
The structure used in this project was the improved Flat Structure because it fulfills the needs of the project based on its size and complexity.
The state of the entire app was managed using Redux Store.
The website is populated with data coming from the Financial Modeling Prep API. Fetch() was used to make the requests, since the response data for this API is simple to handle and doesn't demand sophisticated processing.
This project was built following the rules of ESLint and Stylelint.
- Javascript
- ReactJS
- Redux
- yarn
- Styled Components
- Financial Modeling Prep API
You'll need a package manager to install the dependencies listed in package.json in order to make it work in your local machine. This project used YARN. The installation guide can be found Here.
To setup the project, run the following commands on terminal:
$ cd <folder> (the place you want to have the files installed)
$ git clone https://github.com/ldelbel/react-capstone.git
$ cd react-capstone
$ yarn install
This will install the dependencies in your local machine. This process can take a few minutes.
After installing the dependencies you can start the application running the code below
$ yarn start
If your default browser doesn't open automatically, visit http://localhost/3000.
To run the tests, use the command below
$ yarn test
Which will run the tests using Jest and React Testing Library.
Contributions, issues and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- Microverse: @microverse
- React: @react
- Financial Modeling Prep API: @financialmodelingprep
- Denys Chagaida's 'Pimp My Dog Online Store': @pimp-my-DOG