biketag-vue/README.md

<h1 align=center>BikeTag-Vue</h1> <div align="center"> <img alt="biketag-vue logo" src="https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/Tag-Logo-Stacked-V2-medium.png" height="auto" width="200" style="border-radius:25%;">

<h1 align=center>BikeTag-Vue</h1>
<div align="center">
<img alt="biketag-vue logo" src="https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/Tag-Logo-Stacked-V2-medium.png" height="auto" width="200" style="border-radius:25%;">
</div>
<p align="center">
  <a href="https://app.netlify.com/sites/biketag/deploys">
    <img alt="Netlify Status" src="https://api.netlify.com/api/v1/badges/fe7ffef3-ea39-4e5b-a5b8-3ff6f96f45e4/deploy-status">
  </a>
  <br>
  <a href="https://www.gnu.org/licenses/agpl-3.0.en.html">
    <img src='https://img.shields.io/github/license/KenEucker/biketag-vue' alt='license'>
  </a>
  <br>
  <a href="https://github.com/sponsors/KenEucker">
    <img alt="Sponsors" src="https://img.shields.io/github/sponsors/keneucker">
  </a>
  <a href="https://gitter.im/biketagorg/community">
    <img alt="Sponsors" src="https://badges.gitter.im/gitterHQ/gitter.png">
  </a>
</p>
<p align="center">
  <a href="https://github.com/keneucker/biketag-vue/discussions">
    <img alt="Join the community on GitHub Discussions" src="https://img.shields.io/badge/Join%20the%20community-on%20GitHub%20Discussions-blue">
  </a>
</p>

<p align=center>The Official BikeTag component library for Vue 3.</p>

## 🚀 Installation

Install using your package manager of choice:

```bash
npm install biketag-vue
```

## 📺 Demo

https://biketag.net/component-playground

## ⚙️ Usage

Import the component locally or define it globally and include the css file:

```vue
<template>
  <bike-tag />
</template>

<script lang="ts" setup>
import { BikeTag } from 'biketag-vue';
import 'biketag-vue/dist/style.css';
</script>
```

## 📃 Props

| Name       | Type               | Default | Description                        |
| ---------- | ------------------ | ------- | ---------------------------------- |
| `v-model`  | `boolean/null`     |         | Standard two way input             |
| `disabled` | `boolean`          | false   | Makes the component uninteractable |
| `color`    | `string`           | #3ba13b | Color of the checkbox background   |
| `label`    | `string/undefined` |         | Checkbox label                     |


<h3 align="center">BikeTag Vue and The Official BikeTag App</h3>

<div align="center">

## Getting Started With Running The Source Code

`npm install`

then

`npm run dev`

### Configuration

You will need to modify your hosts file to include at least one entry for testing a BikeTag Game, Portland example:
```sh
# /etc/hosts
...
127.0.0.1    portland.localhost
...
```

The BikeTag APP does not require any special configuration in order to run the site in read-only mode. You will not be able to upload images to a given game, but you can see all of the content of the available games at biketag.org.

### Adding credentials for uploading/editing content

Below you will find some of the primary settings for testing all features of the BikeTag App. You can find all of the [configuration values in the wiki](https://github.com/KenEucker/biketag-vue/wiki/Configuration).
</div>

```sh
#.env
# Used for internal authentication
ADMIN_EMAIL=admin@email.com
HOST_KEY=anythingyouwantititobe
CLIENT_KEY=BIKETAGACCESSKEY
# Used for uploading new BikeTag posts
IMGUR_CLIENT_ID=IMGURCLIENTID
IMGUR_CLIENT_SECRET=IMGURCLIENTSECRET
IMGUR_REFRESH_TOKEN=IMGURCLIENTREFRESH
IMGUR_ADMIN_REFRESH_TOKEN=IMGURADMINREFRESH
# Used for google maps integration
GOOGLE_API_KEY=GOOGLEAPIKEY
# Used for BikeTag Player and BikeTag Ambassador logins
AUTH0_CLIENT_ID=AUTH0CLIENTID
AUTH0_DOMAIN=AUTH0DOMAIN
AUTH0_TOKEN=AUTH0TOKEN
AUTH0_AUDIENCE=AUTH0AUDIENCE
```
<div align="center">

## Credits

This project was started, managed, funded, deployed, and ultimately delivered by a single contributor. This project, and the [BikeTag API][biketag-api] that it uses, is the culmination of four years of attempting to _"make it easy for anyone and everyone to play the game of BikeTag in their area"_. Thanks to those who helped finish up features and polish the UI so that this one single contributor could meet their goal.

Many thanks to those who have donated to the BikeTag Project.

Thank you to [Netlify][netlify] for providing a [free open source plan][netlify-opensource] for hosting.

Support the BikeTag Project on [GitHub][github], [Patreon][patreon], or directly by going out and playing a round of [BikeTag in your city](https://biketag.org)!

  ![Alt](https://repobeats.axiom.co/api/embed/c11cc935c10205774c8d5f48a95f6a313095845f.svg "Repobeats analytics image")

  ## Vendors


[github]: https://github.com/sponsors/KenEucker
[patreon]: https://patreon.com/BikeTag
[biketag-api]: https://github.com/keneucker/biketag-api
[sanity]: https://www.sanity.io/docs/api-versioning
[imgur]: https://www.npmjs.com/package/imgur/v/next
[netlify]: https://www.netlify.com
[netlify-opensource]: https://www.netlify.com/legal/open-source-policy


  Images powered by imgur.com

  [![imgur.com][imgur-image]](https://apidocs.imgur.com/)

  Structured Content powered by sanity.io

  [![sanity.io][sanity-image]](https://www.sanity.io/docs/http-api)

  [biketag-logo]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/biketag-api-logo.jpg
  [imgur-image]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/imgur-logo.png
  [sanity-image]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/sanity-logo.png

  ## Deployed on Netlify servers
  <a href="https://www.netlify.com">
    <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
  </a>
</div>