holodex's Introduction

Holodex

Changelog

Reporting a Bug/Feature Request

For bugs, please make sure to include a picture describing the issue (if applicable)
If the bug is urgent, please send us a message in the Discord server
Check out the Project Board for what we're working on!

Setup for Development

git clone [email protected]:RiceCakess/Holodex.git
npm install
# By default the api is proxied to staging, copy, rename and edit the .env.placeholder to change API_BASE_URL
npm run serve

Building

npm run build
# Analyzing build bundle size
npm run analyze-build

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Check out the Project Board for things being planned

Project Structure

docs    # Changelog, hosted on Github Pages
public  # Static resources
src
├── components              # Vue components
├── locales                 # UI text translations for each languages
├── plugins                 # Vuetify, i18n and other plugin definitions
├── mixins                  # Vue mixins commonly used across components
├── external                # External components we imported into the project for maintenance / updating
├── router                  # Router definitions for path and views
├── store                   # Vuex store modules, each file loosley corresponds to each page.
├── utils                   # Utility declarations
├── views                   # Vue Page defintions
└── App.vue                 # Main entry point, sets up router-view

Roadmap

Watch Page refresh
Make repo public
Add user logins
- save favorites to database
- add video commenting??
Add multi language support
- Use tagging system?? or maybe just have a row indicating language
Expand vtuber list
Updated tagging system
- User contributed tagging
- Tag aliasing
- Tag categories
public API / API key for user account
live chat features / TL transcript
music player / radio / tagging songs in singing streams

Recommend Projects