https://github.com/thecodingcouple/gren-con-client
Source code for https://www.gren-con.com
https://github.com/thecodingcouple/gren-con-client
Last synced: 4 months ago
JSON representation
Source code for https://www.gren-con.com
- Host: GitHub
- URL: https://github.com/thecodingcouple/gren-con-client
- Owner: thecodingcouple
- License: mit
- Created: 2022-05-04T01:27:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-13T01:29:45.000Z (about 4 years ago)
- Last Synced: 2025-01-27T19:55:11.992Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.gren-con.com
- Size: 3.73 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gren-con-client
Source code for https://www.gren-con.com (Work in progress)
[Click here](https://github.com/thecodingcouple/gren-con-api) to view source code for the API.
## Synopsis
We are building a website for hosting information about Gren Con, one day filled with gaming!
Why go through all this effort you may ask? For learning! This is an excuse to learn new skills and become more proficient with existing skills.
## Built With
* [Vue 3](https://vuejs.org/)
* [BoardGameGeek API v2](https://boardgamegeek.com/wiki/page/BGG_XML_API2) (For Game Library page)
## Third Party Assets
* [Dice Image](https://unsplash.com/photos/hFSnuPi0t3Q) by Joe Maldonado
## Connecting to the BoardGameGeek XML API
[BoardGameGeek](https://boardgamegeek.com/) has a [public XML API](https://boardgamegeek.com/wiki/page/BGG_XML_API2) for retrieving data from their site, including user game collections. Here is a request to retrieve [townsean's game collection](https://boardgamegeek.com/collection/user/townsean?own=1&subtype=boardgame&ff=1):
`https://boardgamegeek.com/xmlapi2/collection?username=townsean&own=1`
Initial requests return with the following message:
```xml
Your request for this collection has been accepted and will be processed. Please try again later for access.
```
Subsequent requests will return the user's game collection:
```xml
3·4 = Klatsch!
2008
https://cf.geekdo-images.com/h_hWzVKVM9qY8Dk422lVZw__original/img/udorUI1yjmfrHnxNeo_gNrPCTCA=/0x0/filters:format(jpeg)/pic322180.jpg
https://cf.geekdo-images.com/h_hWzVKVM9qY8Dk422lVZw__thumb/img/0kono0ts2ttycTtzVi5zQnneYHM=/fit-in/200x150/filters:strip_icc()/pic322180.jpg
3
Where was this game when I was memorizing the times table? The component quality is great. I've only played this game with adults and each game was an enjoyable experience. :)
Zingo! Sight Words
2012
https://cf.geekdo-images.com/XU7mIj2i1jIlDQ5_SJ0KlQ__original/img/h-H8XJ9wyCoCaVhXNQ_SgOv68FY=/0x0/filters:format(jpeg)/pic2047488.jpg
https://cf.geekdo-images.com/XU7mIj2i1jIlDQ5_SJ0KlQ__thumb/img/ndAULDYZaaL51GfAL-VPFBMXhsE=/fit-in/200x150/filters:strip_icc()/pic2047488.jpg
1
Zingo! Time-telling
2014
https://cf.geekdo-images.com/nx67vi4AvBcEVLCBGqjkCA__original/img/tG3LLDTMHQnhRLlJtwcHzeXx878=/0x0/filters:format(jpeg)/pic2047489.jpg
https://cf.geekdo-images.com/nx67vi4AvBcEVLCBGqjkCA__thumb/img/lBDu3PIGZoxady2L-YvF4y9NmVI=/fit-in/200x150/filters:strip_icc()/pic2047489.jpg
0
Zooscape
2015
https://cf.geekdo-images.com/3vDjlyTy-gaoz-cTLT9h1Q__original/img/MvvupVNRiV2VZn0PRxYiGrA1R8c=/0x0/filters:format(png)/pic3415495.png
https://cf.geekdo-images.com/3vDjlyTy-gaoz-cTLT9h1Q__thumb/img/iE4U9QvqtNMnrLpDJ_Yx8hg-YTA=/fit-in/200x150/filters:strip_icc()/pic3415495.png
0
```
Here's an example to request additional details on a specific game: `https://boardgamegeek.com/xmlapi2/thing?id=35610`
Which will provide the following XML data:
```xml
https://cf.geekdo-images.com/h_hWzVKVM9qY8Dk422lVZw__thumb/img/0kono0ts2ttycTtzVi5zQnneYHM=/fit-in/200x150/filters:strip_icc()/pic322180.jpg
https://cf.geekdo-images.com/h_hWzVKVM9qY8Dk422lVZw__original/img/udorUI1yjmfrHnxNeo_gNrPCTCA=/0x0/filters:format(jpeg)/pic322180.jpg
A player chooses a numbered flower on his/her turn. ("Let's multiply by fives.") When everyone is ready, roll a die, and quickly multiply the numbers on each. Be the first to swat the fly card with the correct product to earn a wooden fly token. Collect eight tokens to win. Contents: 45 wooden flies, 42 fly cards, 6 fly swatters, 5 flowers, 5 flower cards, and 2 dice
```
## Useful Resources
* https://stripesgenerator.com/
* https://color.adobe.com/create/color-wheel
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
### Deploy to gh-pages
```sh
git add dist && git commit -m "updating gh-pages"
git subtree push --prefix dist origin gh-pages
```
or
```sh
git push origin :gh-pages && git subtree push --prefix dist origin gh-pages
```
## Maintainers
* [Ashley Grenon - @townsean](https://github.com/townsean)
* [Brodavi - @brodavi](https://github.com/brodavi)
* [Dickie - @DickieTheProgrammer](https://github.com/DickieTheProgrammer)
* [Michael Grenon - @nsipid](https://github.com/nsipid)
## License (MIT)
MIT License
Copyright (c) 2022 The 42nd
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.