Holodex

# Holodex

[![MIT License](https://img.shields.io/github/license/RiceCakess/Holodex)](https://github.com/RiceCakess/Holodex/blob/HEAD/LICENSE)
[![Discord Chat](https://img.shields.io/discord/796190073271353385.svg)](https://discord.gg/jctkgHBt4b)
[![Deploy to Prod](https://github.com/RiceCakess/holoclips/workflows/Deploy%20to%20production/badge.svg)](https://github.com/RiceCakess/holoclips/actions?query=workflow%3A%22Deploy+to+production%22)
[![Crowdin](https://badges.crowdin.net/holodex/localized.svg)](https://crowdin.com/project/holodex)
[![Twitter Follow](https://img.shields.io/twitter/follow/holodex?style=social)](https://twitter.com/holodex)

![holodex](https://github.com/RiceCakess/Holodex/blob/dev/public/img/intro-promo.jpg)

## [Changelog](https://github.com/HolodexNet/Holodex/blob/dev/docs/CHANGELOG.md)

## 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](https://github.com/RiceCakess/Holodex/projects) for what we're working on!

## Setup for Development

### Important: the bulk of development is currently happening on the `next` branch!!! If you would like to participate in Holodex React development, please check out the `next` branch and PR against it! The contribution/development readme is in `/package/react/README.md`!

```
git clone git@github.com:HolodexNet/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](https://github.com/RiceCakess/Holodex/projects) 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

- [x] Watch Page refresh
- [x] Make repo public
- [x] Add user logins
  - save favorites to database
  - add video commenting??
- [x] Add multi language support
  - Use tagging system?? or maybe just have a row indicating language
- [x] Exp