Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anselemodims/mazeflix
MazeFlix is an entertainment hub where you can find the latest and your favorite TV shows. You can view the details of the show, like a show or even comment. You can also see other comments which might give you a general idea about what people think about the show. It is built with HTML, CSS and JavaScript with data from the TvMaze API(tv show data) and the Involvement API(likes and comments)
https://github.com/anselemodims/mazeflix
api javascript pure-css responsive shows tv webpack
Last synced: about 13 hours ago
JSON representation
MazeFlix is an entertainment hub where you can find the latest and your favorite TV shows. You can view the details of the show, like a show or even comment. You can also see other comments which might give you a general idea about what people think about the show. It is built with HTML, CSS and JavaScript with data from the TvMaze API(tv show data) and the Involvement API(likes and comments)
- Host: GitHub
- URL: https://github.com/anselemodims/mazeflix
- Owner: AnselemOdims
- License: mit
- Created: 2021-12-20T11:47:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-19T11:01:48.000Z (over 2 years ago)
- Last Synced: 2024-05-28T16:59:02.106Z (4 months ago)
- Topics: api, javascript, pure-css, responsive, shows, tv, webpack
- Language: JavaScript
- Homepage: https://anselemodims.github.io/MazeFlix/
- Size: 11.2 MB
- Stars: 25
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MazeFlix
> MazeFlix is an entertainment hub where you can find the latest and your favorite TV shows. You can view the details of the show, like a show or even comment. You can also see other comments which might give you a general idea about what people think about the show.
> It is built with HTML, CSS and JavaScript with data from the TvMaze API(tv show data) and the Involvement API(likes and comments)
## Project Presentation
[Presentation Link](https://www.veed.io/view/3b918feb-78c4-4b42-b1f4-fe8fb909715b)
## Mini Demo
Additional description about the project and its features.
## Built With
- Major languages (HTML, CSS, JavaScript)
- Frameworks (None)
- Technologies used
``` bash
- Webpack(Code Bundlng et al)
- Jest(for testing)
- Git(version control)
- ESLint(JavaScript linting)
- WebHint(linting tool)
- Stylelint(style linting)
```
## Live Demo
[Website Link](https://anselemodims.github.io/MazeFlix/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- A text editor(preferably Visual Studio Code)
### Install
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
### Usage
#### Clone this repository
```bash
$ git clone [email protected]:AnselemOdims/MazeFlix.git
$ cd MazeFlix
```
#### Run project
```bash
$ npm install
$ npm run start # this will make webpack watching for your changes in code
$ npm run test #This is to run the tests on the count method
```
#### Open page in browser
```bash
$ open dist/index.html
```
## Interaction with the TvMaze API
- Each new query for TV shows is done with the GET method using the BASEURL
```bash
https://api.tvmaze.com/
```
To get all shows that the title begin with 'a', GET request will be made to the below URL
```bash
https://api.tvmaze.com/search/shows?q=a
```
## Interaction with the Involvement API
- Each new query for Involvement API is done using the below as the BASEURL
```bash
https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/
```
- To create a new app, a POST request is made to the API using the endpoint
```bash
/apps/
```
This returns the appID
```bash
abc234
```
### Likes
- A POST request is made to the API when a user clicks on the like button using this endpoint:
#### Endpoint
```bash
/apps/:app_id/likes/
```
body parameters
```bash
{
"item_id": "item1"
}
```
Return value for POST action: 201 status (created)
- The GET request returns data in JSON format like this:
```bash
[
{
"likes": 5,
"item_id": "item1"
},
{
"likes": 10,
"item_id": "item2"
}
]
```
### Comments
- A POST request is made to the API when a user clicks on the like button using this endpoint:
#### Endpoint
```bash
/apps/:app_id/comment/
```
body parameters
```bash
{
"item_id": "item1",
"username": "Jane",
"comment": "Hello"
}
```
Return value for POST action: 201 status (created)
- The GET request returns data in JSON format like this:
#### Endpoint
```bash
/apps/abc234/comments?item_id=item1
```
It returns
```bash
[
{
"comment": "This is nice!",
"creation_date": "2021-01-10",
"username": "John"
},
{
"comment": "Great content!",
"creation_date": "2021-02-10",
"username": "Jane"
}
]
```
## Authors
👤 **Anselem Odimegwu**
- GitHub: [github](https://github.com/AnselemOdims)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/anselem-odimegwu/)
👤 **Mubarak Ibrahim**
- GitHub: [github](https://github.com/imubarak234)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/imubarak-ibrahim-1540a5208/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/AnselemOdims/MazeFlix/issues).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.