An open API service indexing awesome lists of open source software.

https://github.com/rebaz36/react-template


https://github.com/rebaz36/react-template

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

![](https://img.shields.io/badge/Microverse-blueviolet)

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 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)
- [📝 License](#license)

# 📖 Cryptic World

**Cryptic World** is a Project that uses a Crypto API, to fetch data about Crypto Currencies, and information about them it displays them in the home page, and allows user to filter them. user can also navigate to details page by clicking on a crypto and see more information

## 🛠 Built With

### Tech Stack

Client

### Key Features

- **[Searching Through the available Crypto Currencies]**
- **[Viewing Details on any Crypto Currencies]**
- **[Going back to Previous Page]**
- **[Stroing Data in Redux Store]**

(back to top)

## 🚀 Live Demo

- [Live Demo](https://rebaz36.github.io/React-Capstone/)
- [Loom Video Pesentation](https://www.loom.com/share/6ec49865b5634a4fa8e74c5d75fb49c9)

(back to top)

## 💻 Getting Started with React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Node.js
- NPM Package Manager

### Setup

Clone this repository to your desired folder:

Example commands:

```
cd React-Capstone
git clone git@github.com:rebaz36/React-Capstone.git
```

### Install

Install this project with:

Example command:

```
cd React-Capstone
npm install or npm i
```

### Usage

To run the project, execute the following command:

Example command:

```sh
npm run start
```

### Run tests

To run tests, run the following command:

Example command:

```sh
npm run test
```

### Deployment

You can deploy this project using:

Example:

```sh
npm run deploy
```

(back to top)

## 👥 Authors

👤 **Author1: Rebaz Farid**

- GitHub: [@rebaz36](https://github.com/rebaz36)
- Twitter: [@rebaz415](https://twitter.com/rebaz415)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/rebazf/)

(back to top)

## 🔭 Future Features

- [ ] **[About Page]**
- [ ] **[Not Found Page]**
- [ ] **[Filter by Value]**

(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 and want to support me make cooler projects Give this project a Star.

(back to top)

## 🙏 Acknowledgments

I would like to thank Nelson Sakwa on Behance for the [Original design idea](https://www.behance.net/sakwadesignstudio).

(back to top)

## 📝 License

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

(back to top)