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

https://github.com/solobarine/nova


https://github.com/solobarine/nova

css3 reactjs typescript

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          


logo

Nova

# 📗 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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Nova

> Describe your project in 1 or 2 sentences.

**Nova** is a web-based platform that allows users to explore and watch their favorite TV series. It provides a seamless experience for users to browse through a vast collection of series, view a list of genres, and access series based on their preferred genre. Users can access a wide range of TV series available on the platform.
Users can access a curated list of genres available on the platform. This feature allows them to explore series based on their preferred genre, such as drama, comedy, action, sci-fi, thriller, and more. Selecting a genre displays a list of series belonging to that genre.

## 🛠 Built With

### Tech Stack

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

Client

Server

Database

### Key Features

> Describe between 1-3 key features of the application.

- **User Authentication using JWT**
- **State Management using Redux**
- **Built with TypeScript**
- **Client Side Pagination**
- **Browse According to Genre**

(back to top)

> Add a link to your deployed project.

- [Live Demo Link](https://nova-solobarine.vercel.app)

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

- Node.js

### Setup

Clone this repository to your desired folder:

```sh
git clone git@github.com:solobarine/nova.git
```

### Install

Install this project with:

```sh
cd nova
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run dev
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Solomon Barine Akpuru**

- GitHub: [@solobarine](https://github.com/solobarine)
- LinkedIn: [LinkedIn](https://linkedin.com/in/solomon-akpuru)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **[Clicking on Cast Name redirects you to their Bio]**
- [ ] **Tests**
- [ ] **Advanced Error Handling**

(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

> Write a message to encourage readers to support your project

If you like this project, leave a Star

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank everyone who contributed to the success of this project.
I would also like to thank TVMaze for their wonderful API. Keep up the good work.

(back to top)

## ❓ FAQ (OPTIONAL)

> Add at least 2 questions new developers would ask when they decide to use your project.

- **I get 429 Error when loading pages**

- This is due to the Rate Limit of the External Api used. Reload the page after sometime and enjoy.

- **Can I clone the project repo?**

- Yes, for personal use only

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)