https://github.com/naledi-dikgale/react-capstone

https://github.com/naledi-dikgale/react-capstone

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/naledi-dikgale/react-capstone
• Owner: Naledi-Dikgale
• License: mit
• Created: 2023-05-21T10:39:45.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-09-18T08:56:18.000Z (about 2 months ago)
• Last Synced: 2024-09-18T11:45:00.662Z (about 2 months ago)
• Language: JavaScript
• Size: 638 KB
• Stars: 16
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

   - [🚀 Live Demo](#live-demo)

    - [Video Walkthrough](#video-walkthrough)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Stock-Market Project 

**Stock-Market Project** Stock-Market is an application that displays a list of businesses and the overview of their finances, allows the user to filter and search for details of specific business.

## 🛠 Built With Create React App

### Key Features 

- **Project setup with Create React App**

(back to top)


## 🚀 Live Demo 

- [video link]()

- [Live Demo Link](https://stock-market-2xyl.onrender.com)

(back to top)


## 💻 Getting Started 

Try to have these in your local machine

- Git and GitHub

- VS Code or any code editor

### Prerequisites

In order to run this project you need 

- A web browser

- Code editor

### Setup

Clone this repository to your desired folder:

git clone https://github.com/Naledi-Dikgale/react-capstone.git

### Install

Install this project using the cloned repo or download and use the files to your local machine.

### Usage

- Clone the repository first

- Commnads to Run: 

    - npm install

    - npm run build

    - npm start

### Run tests

- tests are included using Jest framework

- commands to run:   npm run test 

### Deployment

You can deploy this project through Github Pages

(back to top)


## 👥 Authors 

👤 **Naledi Dikgale**

- GitHub: [@githubhandle](https://github.com/Naledi-Dikgale)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/naledi-dikgale-068423159/)

- Website: [@naledi_dikgale](https://nalediportfolio.netlify.app/)

(back to top)


## 🔭 Future Features Animation

- [ ] **Changes will be made as comming project requirement.**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project give a star to this repositiory.

(back to top)


## 🙏 Acknowledgments  Nelson Sakwa on Behance

- I would also like to thank Microverse for the guidance they made all the way up to this point. 

(back to top)


## ❓ FAQ 

- **Is it allowed to copy the contents of this project and use it for personal use?**

  - This project is free for copying and reusing in any way you like.

## 📝 License 

This project is [MIT](./LICENSE.md) licensed.

(back to top)