Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnftitor/anime-list
This website was built using React and Redux. The main objective was to fetch data from an external API using the thunk middleware within the redux store, holding different states for each part of the app and filtering data based on user parameters.
https://github.com/johnftitor/anime-list
api javascript jest react react-redux scss
Last synced: 10 days ago
JSON representation
This website was built using React and Redux. The main objective was to fetch data from an external API using the thunk middleware within the redux store, holding different states for each part of the app and filtering data based on user parameters.
- Host: GitHub
- URL: https://github.com/johnftitor/anime-list
- Owner: JohnFTitor
- Created: 2022-03-07T17:36:19.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-27T04:10:27.000Z (over 2 years ago)
- Last Synced: 2023-03-05T12:31:38.660Z (over 1 year ago)
- Topics: api, javascript, jest, react, react-redux, scss
- Language: JavaScript
- Homepage: https://jfanime-list.netlify.app/
- Size: 58.2 MB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
# Anime List
> This website was built using React and Redux. The main objective was to fetch data from the [Jikan API](https://jikan.moe/) using the thunk middleware within the redux store, holding different states for each part of the app and filtering data based on user parameters.
## Desktop Preview
## Mobile Preview
Have you ever felt like you wanted to watch a new Anime, but nothing seemed to catch your attention? No need to worry anymore! Here's a short but concise list of the 50 most scored animes for 5 types (Making a total of 250 Animes!) from which you can pick one you'll like to see. Additionally, you can check the list type to enjoy the best tracks used in the Anime industry! If you enjoy the Japanese animation industry, then you'll enjoy this fan page.
## Live Version
[Netlify](https://jfanime-list.netlify.app/)
## Built With
- HTML/SCSS and JavaScript
- React Framework, Redux, Redux Toolkit
- Jest
## Getting Started
To get a local copy up and running follow these simple example steps.
- Clone this repository with git clone```[email protected]:JohnFTitor/anime-list.git``` using your terminal or command line.
- Change to the project directory by entering :
```cd anime-list``` in the terminal
### Prerequisites
You need to make sure to have installed the latest version of Node.js and npm on your computer.
### Setup
You can clone this repository or simply download the files as a .zip
If you want to set up a personal repository based on this one, you can as well fork it.
### Install
After clone it and before working on it, you have to run ```npm install``` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include React app and linters checks, for which you have to install the files following the ```wget``` commands inside linters.yml file.
### Usage
You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below
To work on the project, run ```npm start``` in your terminal to deploy a live version of the development. This works in watch mode so it automatically reloads any need change you make to the files.
### Run linters checks
Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.
## Testing
Run ```npm test``` to check prepared test cases related to the website functionality simulating user interaction.
## Deployment
Netlify is set to automatically deploy the production branch (main branch) of this project, so you don't need to worry about it.
Heroku is manually deployed by our team whenever required. That is, when the main branch gets updated.
## Authors
👤 **Andrés Felipe Arroyave Naranjo**
- GitHub: [@JohnFTitor](https://github.com/JohnFTitor)
- Twitter: [@johnftitor](https://twitter.com/johnftitor)
- LinkedIn: [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)
## Acknowledgments
### Web Design
The [template](https://www.behance.net/gallery/31579789/Ballhead-App-%28Free-PSDs%29) style guidelines such as the layout distribution and selected fonts for the whole project were designed by [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) on Behance. This project worked based on it, selecting new colors and changing the nature of the content.
Check Nelson's page for more amazing GUI and Graphic designs!
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.