https://github.com/inspecta/readme

https://github.com/inspecta/readme

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/inspecta/readme
• Owner: inspecta
• Created: 2022-11-25T14:56:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-25T15:30:20.000Z (over 3 years ago)
• Last Synced: 2025-09-06T14:54:17.367Z (9 months ago)
• Size: 543 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

  


  
CRYPTOX




# 📗 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)

# 📖 CRYPTOX

**CRYPTOS** is a React-Redux application built on top of the CoinApp API.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

  


  Server

  


    
Redux

  


Database

  


    
None

  


### Key Features 

- **Fetch API using AXIOS**

- **Store the data in a Redux Slice/Store**

- **Display the data**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://magical-stardust-f24388.netlify.app/)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

### Setup

Clone this [repository](https://github.com/inspecta/CryptoX) to your desired folder:

`git clone https://github.com/inspecta/CryptoX.git`

### Install

Install this project with:

- Navigate to the Repo Folder 

- `cd CyrptoX`

- Install application dependencies (Node has to be installed)

- `npm install`

### Usage

To run the project, execute the following command:

`npm start`

### Run tests

To run tests, run the following command:

`npm test`

### Deployment

You can deploy this project using:

Github Pages or Netlify

(back to top)


## 👥 Mulinde Derrick 

👤 **Author1**

- GitHub: [@inspecta](https://github.com/inspecta)

- Twitter: [@djmulinde](https://twitter.com/djmulinde)

- LinkedIn: [LinkedIn](https://linkedin.com/in/derrick-mulinde)

(back to top)


## 🔭 Future Features 

- [ ] **Update the application in real time**

- [ ] **Add Cypto Currency symbols**

- [ ] **A better UI**

(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, kinldy star it.

(back to top)


## 🙏 Acknowledgments 

- I would like to thank [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) of [Behance](https://www.behance.net/adagio07) for providing us with the amazing mobile [Template](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs))

- Thanks [Microverse](https://microverse.org) for the material you have provided during my development.

(back to top)


(back to top)


## 📝 License 

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

(back to top)