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.

Apple Inc

📗 Table of Contents

• � Table of Contents
• 📖 Apple Inc
• 🛠 Built With
  • Tech Stack
  • Key Features
• 🚀 Live Demo
• 🎬 Representation
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Deployment
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• ❓ FAQ
• 📝 License

📖 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. 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.

🛠 Built With

Tech Stack

Technology

• React - A frontend framework for building user interfaces
• Redux - A predictable state management library for JavaScript applications.
• JavaScript - A high-level programming language used for web development.
• npm - A package manager for the Node.js runtime environment
• Create React App - A tool used to quickly set up a modern React web application with no build configuration required.
• HTML - A markup language used for creating web pages
• CSS - A style sheet language used for describing the presentation of a document written in HTML

Tools

• VSCode
• Git
• node
• npm
• webpack

Key Features

• 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

(back to top)

🚀 Live Demo

• Click here to view the live Demo.

🎬 Presentation

• A Presentation of the project by the author. Watch here

(back to top)

💻 Getting Started

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
• git-scm
• A Github account
• NodeJS (which also includes npm package manager)

Setup

Clone this repository to your desired folder by running the following command:

  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

  cd apple-inc
  npm install

Usage

To build the project:

  npm run build

Run npm start to start and view the project in browsers:

  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.

 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, you can follow their documentation on deploying a React application.

• If you're using Vercel, you can follow their documentation on deploying a Next.js application.

• 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.

(back to top)

👥 Author

👤 Spencer Okyere

• GitHub: @skabeo
• Twitter: @black_okyere
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• 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.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

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.

(back to top)

⭐️ Show your support

If you like this project, please give it a star on GitHub.

(back to top)

🙏 Acknowledgments

I would like to express my gratitude to the following individuals and organizations for their contributions to this project:

• React: JavaScript library for building user interfaces
• Create React App: Tool for creating React applications with zero configuration
• GitHub: Platform for version control and collaboration
• Microverse: Global school for remote software developers

Special thanks to Nelson Sakwa for the design inspiration.

(back to top)

❓ FAQ

• 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.

(back to top)

📝 License

This project is MIT licensed.

(back to top)