README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • 🚀 Live Demo
  • Video Walkthrough
  • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 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

(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
• LinkedIn: LinkedIn
• Website: @naledi_dikgale

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

(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 licensed.

(back to top)