Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bourgeoisor/xivtodo

Dashboards, tailored checklists and tools for Final Fantasy XIV.
https://github.com/bourgeoisor/xivtodo

checklists dashboards ffxiv final-fantasy final-fantasy-xiv todolist todos tools vuejs xiv-resources

Last synced: about 2 months ago
JSON representation

Dashboards, tailored checklists and tools for Final Fantasy XIV.

Host: GitHub
URL: https://github.com/bourgeoisor/xivtodo
Owner: bourgeoisor
License: gpl-3.0
Created: 2021-05-29T02:36:38.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-04-09T05:44:27.000Z (about 2 months ago)
Last Synced: 2024-04-09T06:32:10.873Z (about 2 months ago)
Topics: checklists, dashboards, ffxiv, final-fantasy, final-fantasy-xiv, todolist, todos, tools, vuejs, xiv-resources
Language: Vue
Homepage: https://xivtodo.com
Size: 30.5 MB
Stars: 119
Watchers: 6
Forks: 18
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md

Lists

awesome-vue - XIV ToDo - Dashboards, completion trackers, tailored weekly and daily checklists and tools for Final Fantasy XIV. (Projects Using Vue.js / Open Source)
awesome-vue - XIV ToDo - Dashboards, completion trackers, tailored weekly and daily checklists and tools for Final Fantasy XIV. (Projects Using Vue.js / Open Source)
awesome-vue - XIV ToDo - Dashboards, completion trackers, tailored weekly and daily checklists and tools for Final Fantasy XIV. (Projects Using Vue.js / Open Source)

README

# XIV ToDo

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fxivtodo.com)](https://xivtodo.com/)
[![Discord](https://img.shields.io/discord/946996969354690600?label=discord)](https://discord.gg/zfzhKhG3zj)
[![ko-fi](https://img.shields.io/badge/buy%20me%20a%20coffee!-donate-success)](https://ko-fi.com/V7V569BFY)
[![fr translation](https://img.shields.io/badge/dynamic/json?color=blue&label=fr&style=flat&logo=crowdin&query=%24.progress.1.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15746609-575411.json)](https://crowdin.com/project/xiv-todo)
[![de translation](https://img.shields.io/badge/dynamic/json?color=blue&label=de&style=flat&logo=crowdin&query=%24.progress.0.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15746609-575411.json)](https://crowdin.com/project/xiv-todo)
[![ja translation](https://img.shields.io/badge/dynamic/json?color=blue&label=ja&style=flat&logo=crowdin&query=%24.progress.2.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15746609-575411.json)](https://crowdin.com/project/xiv-todo)

[XIV ToDo](https://xivtodo.com) provides useful dashboards, tailored checklists and tools for Final Fantasy XIV. Whether you are a new player to the game or more experienced, you will find it useful! In its current form, XIV ToDo offers customizable daily and weekly checklists as well as automated completion trackers of emcounters and questlines, with much more to come!

## Features

- Support for adding multiple characters.
- Profile containing publicly accessible Lodestone information.
- List of all encounters up-to-date with automatic character completion status.
- List of all important questlines with automatic character completion status.
- Comprehensive list of dailies and weeklies with per-character completion and customization.

## Screenshots

## Development

### Frontend

1. Make sure you have the following requirements:
- Node.js 20+ installed locally
- npm installed locally
- Vue's CLI installed locally (`npm install -g @vue/cli`)

2. Clone the repository:
```sh
git clone https://github.com/bourgeoisor/xivtodo
cd xivtodo/frontend/
```

3. Fetch dependencies:
```sh
npm install
```

4. Run one of the following commands:
```sh
npm run serve # serve the frontend locally
npm run build # build the dist directory
npm run lint # lint the frontend
vue ui # open vue's interactive ui
```

By default, the frontend will attempt to use a local backend (`localhost:8181`). To develop against the production backend, modify the following environment variable in the `.env` file before serving:
```sh
VUE_APP_BACKEND_API_URI=https://api.xivtodo.com
```

**Note**: With that setup, you will not be able to sign in with Discord due to security policies. It is recommended to run both the frontend and backend locally.

### Backend

1. Make sure you have the following requirements:
- Google Cloud project with the Firestore API enabled
- Service Account with RW permissions to Firestore
- Discord application with an OAuth2 redirect to `http://localhost:8080/auth`
- Go 1.22+ installed locally

2. Clone the repository:
```sh
git clone https://github.com/bourgeoisor/xivtodo
cd xivtodo/backend/
```

3. Fetch dependencies:
```sh
go mod
```

4. Set the following environment variables:
```
GOOGLE_APPLICATION_CREDENTIALS=backend-sa.json # Google Cloud service account key
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=
DISCORD_REDIRECT_URI=http://localhost:8080/auth
```

5. Run the backend server:
```sh
go run main
```

## Contributing

Contributions are welcome and appreciated. Simply open up a new issue, or fork the repository to open up a new pull request against the upstream main branch.