Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r1pk/anitrivi
Responsive web application built using React, React-Router and Material UI-that allows users to guess a random anime every day based on their completed anime list.
https://github.com/r1pk/anitrivi
anilist-api material-ui react react-router reactjs
Last synced: 27 days ago
JSON representation
Responsive web application built using React, React-Router and Material UI-that allows users to guess a random anime every day based on their completed anime list.
- Host: GitHub
- URL: https://github.com/r1pk/anitrivi
- Owner: r1pk
- License: mit
- Created: 2023-03-19T17:46:47.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T21:39:17.000Z (9 months ago)
- Last Synced: 2024-04-14T12:05:39.010Z (9 months ago)
- Topics: anilist-api, material-ui, react, react-router, reactjs
- Language: JavaScript
- Homepage: https://anitrivi.vercel.app
- Size: 308 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AniTrivi
AniTrivi is a web application developed using [React](https://reactjs.org/) and [AniList API](https://anilist.gitbook.io/anilist-apiv2-docs/) that allows users to guess anime titles from their completed anime list based on provided clues.
## Screenshots
Guessing phase
Featured anime revealed
## Pre-requisites
Application was developed and tested in a stable environment, utilizing the following versions:
- [node.js v19.7.0](https://nodejs.org/en/)
- [npm v9.6.0](https://nodejs.org/en/download/)
This ensures that the application runs smoothly and efficiently.
## Run Locally
Clone the project
```bash
git clone https://github.com/r1pk/anitrivi.git
```
Go to the project directory
```bash
cd anitrivi
```
Install dependencies
```bash
npm install
```
Run the project locally
```bash
npm run dev
```
## Project file structure
```bash
anitrivi/ # root directory
├─ public/ # static files
├─ src/ # application source code
│ ├─ apis/ # api related files
│ ├─ components/ # reusable components grouped by features
│ ├─ configs/ # configuration files
│ ├─ contexts/ # context declarations
│ ├─ hooks/ # custom hooks
│ ├─ layouts/ # layout components grouped by layout type
│ ├─ lib/ # declarations related to external libraries
│ ├─ pages/ # page components
│ ├─ themes/ # theme related files (e.g. colors, fonts)
│ ├─ utils/ # utility functions
│ ├─ App.jsx # application root component
│ ├─ AppRoutes.jsx # application routes
│ ├─ main.jsx # application entry point
├─ .env # default environment variables
```
## Demo
Application is automatically deployed using Vercel.
[AniTrivi Live Demo](https://anitrivi.vercel.app/)
## Authors
- [@r1pk](https://github.com/r1pk)
## License
[MIT](https://choosealicense.com/licenses/mit/)