Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skabeo/apple-inc
Apple Inc is a webapp that fetches data from a Financial Modeling Site to display the four main statement of Apple Inc. The Statements displayed includes the Income Statement, Balance Sheet, Cash flow statement and the Equity Statement for the year ended 2022.
https://github.com/skabeo/apple-inc
css html javascript jsx react redux scss
Last synced: 1 day ago
JSON representation
Apple Inc is a webapp that fetches data from a Financial Modeling Site to display the four main statement of Apple Inc. The Statements displayed includes the Income Statement, Balance Sheet, Cash flow statement and the Equity Statement for the year ended 2022.
- Host: GitHub
- URL: https://github.com/skabeo/apple-inc
- Owner: skabeo
- License: mit
- Created: 2023-05-21T21:34:31.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-05-25T21:44:53.000Z (over 1 year ago)
- Last Synced: 2025-02-01T01:51:20.210Z (13 days ago)
- Topics: css, html, javascript, jsx, react, redux, scss
- Language: JavaScript
- Homepage: https://apple-org.onrender.com/
- Size: 771 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Apple Inc
- [οΏ½ Table of Contents](#table-of-contents)
- [π Apple Inc ](#about-project)
- [π Built With ](#built-with)
- [Tech Stack ](#tech-stack)
- [Key Features ](#key-features)
- [π Live Demo ](#live-demo)
- [π¬ Representation](#representation)
- [π» Getting Started ](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Deployment](#deployment)
- [π₯ Author ](#authors)
- [π Future Features ](#future-features)
- [π€ Contributing ](#contributing)
- [βοΈ Show your support ](#οΈsupport)
- [π Acknowledgments ](#acknowledgements)
- [β FAQ ](#faq)
- [π License ](#license)
**Apple Inc** is a webapp that fetches data from a [Financial Modeling Site](https://site.financialmodelingprep.com) to display the four main statement of Apple Inc. The Statements displayed includes the Income Statement, Balance Sheet, Cash flow statement and the Equity Statement for the year ended 2022. On click of a statement, a detailed data regarding the selected statement is shown and a search field to display the list of items input by the users.
Technology
- [React](https://reactjs.org/) - A frontend framework for building user interfaces
- [Redux](https://redux.js.org/) - A predictable state management library for JavaScript applications.
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - A high-level programming language used for web development.
- [npm](https://www.npmjs.com/) - A package manager for the Node.js runtime environment
- [Create React App](https://create-react-app.dev/) - A tool used to quickly set up a modern React web application with no build configuration required.
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - A markup language used for creating web pages
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - A style sheet language used for describing the presentation of a document written in HTML
Tools
- **Ability to see the statements preview with some data**
- **Users can click on a statement to show the detailed information of a statement**
- **A search field to filter out the list displayed**
- Click [here](https://apple-org.onrender.com/) to view the live Demo.
- A Presentation of the project by the author. [Watch here](https://drive.google.com/file/d/1L0weTw9BETtJK74h5boCZrGqM1XxPcS-/view?usp=sharing)
### Prerequisites
In order to reproduce the Apple Inc and be able to make changes for your own purpose, you need the following tools:
- [Visual Studio Code](https://code.visualstudio.com/)
- [git-scm](https://git-scm.com/)
- A [Github](https://github.com/) account
- [NodeJS](https://nodejs.org/) (which also includes npm package manager)
### Setup
Clone this repository to your desired folder by running the following command:
```sh
git clone https://github.com/skabeo/apple-inc.git
```
### Install
To use this application, you need to have Node.js installed on your machine. Once you have Node.js installed,
Run npm install to install all dependencies
```sh
cd apple-inc
npm install
```
### Usage
To build the project:
```sh
npm run build
```
Run npm start to start and view the project in browsers:
```sh
npm start
```
### Run tests
To run tests for the To Do List App, follow these steps:
- Open the command prompt or terminal on your computer.
- Navigate to the project directory using the cd command.
- Type the command npm run test and press enter.
```sh
npm run test
```
This will open the app in your browser at `http://localhost:3000`.
### Deployment
To deploy the Space Travelers' Hub to a live environment, you can follow these steps:
1. Build the production-ready version of the application/
2. Deploy the contents of the `build` directory to your preferred hosting platform.
- If you're using [Netlify](https://www.netlify.com/), you can follow their documentation on [deploying a React application](https://docs.netlify.com/configure-builds/common-configurations/react/).
- If you're using [Vercel](https://vercel.com/), you can follow their documentation on [deploying a Next.js application](https://vercel.com/docs/platform/deployments#deploying-next.js).
- If you're using other hosting platforms, please refer to their documentation for deploying static websites.
3. Once deployed, access the live version of the application.
π€ **Spencer Okyere**
- GitHub: [@skabeo](https://github.com/skabeo)
- Twitter: [@black_okyere](https://twitter.com/black_okyere)
- LinkedIn: [LinkedIn](https://linkedin.com/in/spencer-okyere)
- Previous year financial statement for a side-by-side comparison.
- User authentication and account creation: Allow users to create accounts and authenticate with credentials for a personalized experience.
- Notifications and updates: Implement a notification system to inform users about statements updates.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/skabeo/apple-inc/issues).
If you would like to contribute to this project, you can follow these steps:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Create a pull request back to the original repository.
If you like this project, please give it a star on GitHub.
I would like to express my gratitude to the following individuals and organizations for their contributions to this project:
- [React](https://reactjs.org/): JavaScript library for building user interfaces
- [Create React App](https://create-react-app.dev/): Tool for creating React applications with zero configuration
- [GitHub](https://github.com/): Platform for version control and collaboration
- [Microverse](https://www.microverse.org/): Global school for remote software developers
Special thanks to [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) for the design inspiration.
- **Can I modify and redistribute this project?**
- Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.
- **How can I contribute to this project?**
- Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.
This project is [MIT](https://github.com/skabeo/apple-inc/blob/develop/LICENSE) licensed.