Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keneucker/biketag-vue
A vue app for the game of BikeTag played worldwide at biketag.org including the published biketag-vue component library
https://github.com/keneucker/biketag-vue
bootstrap-vue pinia typescript vite vue-router vue3
Last synced: 14 days ago
JSON representation
A vue app for the game of BikeTag played worldwide at biketag.org including the published biketag-vue component library
- Host: GitHub
- URL: https://github.com/keneucker/biketag-vue
- Owner: KenEucker
- License: agpl-3.0
- Created: 2021-01-07T10:11:42.000Z (almost 4 years ago)
- Default Branch: production
- Last Pushed: 2024-09-23T15:05:17.000Z (about 2 months ago)
- Last Synced: 2024-10-19T05:16:13.809Z (27 days ago)
- Topics: bootstrap-vue, pinia, typescript, vite, vue-router, vue3
- Language: Vue
- Homepage: https://biketag.org
- Size: 36 MB
- Stars: 22
- Watchers: 4
- Forks: 13
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
BikeTag-Vue
The Official BikeTag component library for Vue 3.
## 🚀 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
import { BikeTag } from 'biketag-vue';
import 'biketag-vue/dist/style.css';
```
## 📃 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 |
BikeTag Vue and The Official BikeTag App
## 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).
```sh
#.env
# Used for internal authentication
[email protected]
HOST_KEY=anythingyouwantititobe
ACCESS_TOKEN=BIKETAGACCESSTOKEN
# 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
```
## 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)!
## 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
