Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnnkhndlwl/stocksapp
A Stocks app built with react native
https://github.com/mnnkhndlwl/stocksapp
Last synced: 8 days ago
JSON representation
A Stocks app built with react native
- Host: GitHub
- URL: https://github.com/mnnkhndlwl/stocksapp
- Owner: mnnkhndlwl
- Created: 2024-06-29T10:31:06.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-06-30T17:16:09.000Z (6 months ago)
- Last Synced: 2024-11-06T20:14:23.393Z (about 2 months ago)
- Language: TypeScript
- Size: 406 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⭐ Stocks App built with React Native ⭐
## Table of Contents
- [Overview](#overview)
- [Key Features](#key-features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Feedback](#feedback)
## Overview
The Stocks App is a React Native application that allows users to view stock market data, including top gainers and losers, and a detailed overview of companies. The app also includes internal caching for efficient data retrieval.
## Key Features
- View top gainers and losers
- View a company's overview
- Search stocks
- Internal caching of data
## Installation
To get a local copy up and running, follow these simple steps:
### Prerequisites
- Ensure you have Node.js installed. You can download it from [here](https://nodejs.org/).
### Installation Steps
1. Clone the repository:
```sh
git clone https://github.com/mnnkhndlwl/stocksApp.git
```
2. Navigate to the project directory:
```sh
cd stocksApp
```
3. Install the dependencies:
```sh
npm install
```
4. Start the development server:
```sh
npm run start
```
5. Start the app in emulator/device:
```sh
npm run android/ios
```
## Usage
1. Open the app on your device or simulator.
2. Use the search bar to look for specific stocks.
3. View the top gainers and losers on the main screen.
4. Tap on any stock to see its detailed overview.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
### How to Contribute
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Feedback
If you have any feedback or suggestions, please reach out to the maintainers:
* [Manan Khandelwal](https://github.com/mnnkhndlwl)
---