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

https://github.com/solobarine/nba-world


https://github.com/solobarine/nba-world

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

logo

Microverse README Template

# 📗 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)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [React Redux Capstone]

**[NBA Teams]The user can view all NBA teams.

## 🛠 Built With

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Client

Storage

### Key Features

- **[Single Page Application.]**
- **[The user will see the NBA teams.]**
- **[The user can see teams sorted by Division.]**
- **[The user can return to home.]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://nbaworldsolobarine.netlify.app/)

(back to top)

## 🎥 Video Presentation
- [Video Presentation Link](https://drive.google.com/file/d/15ZbwSRAu4X6y1L_odTFMhu_PGDJL-AaK/view?usp=share_link)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

To have installed [node.js](https://nodejs.org/en/download/) and [Git](https://git-scm.com/downloads)

### Setup

Clone this repository to your desired folder:

First enter the folder you want to save the project.
```sh
cd my-folder
```
After moving into the directory you want to save the project you could clone it using the terminal.

```sh
git clone git@github.com:solobarine/nba-world.git
```

### Install

Install this project with:

```sh
cd nba-world
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm start
```

### Run tests

To run tests, run the following command:

```sh
npm run test
```

(back to top)

## 👥 Author
👤 **Akpuru Solomon Barine

- GitHub: [@Solobarine](https://github.com/Solobarine)
- Twitter: [@SolomonAkpuru](https://twitter.com/SolomonAkpuru)
- LinkedIn: [Solomon Akpuru](https://www.linkedin.com/mwlite/in/solomon-akpuru-17069b241)

(back to top)

## 🔭 Future Features

- [ ] **[Improve styling of the page]**
- [ ] **[Add more information from the API]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/solobarine/nba-world/issues).

(back to top)

## ⭐️ Show your support

If you like this project leave a star.

(back to top)

## 🙏 Acknowledgments

We would like to thank Microverse for letting us be part of this amazing program.
Thanks to Nelson Sakwa for his Design.
And thanks to all the people who helped me to make this project possible.
Checkout his amazing design in [here](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs))

(back to top)

## ❓ FAQ

- **[Can I modify this project?]**

- [Yes, you can make all the changes you'd like locally.]

- **[Can I add more teams to the NBA roster in the API]**

- [No, this API is not created by us.]

(back to top)

## 📝 License

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

(back to top)