mirror of
https://github.com/romancm/gamebrary
synced 2024-11-13 23:17:08 +00:00
84 lines
2.2 KiB
Markdown
84 lines
2.2 KiB
Markdown
|
# SwitchList
|
||
|
|
|
||
|
|
|
||
|
|
User friendly and intuitive tool to keep track of your switch collection.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
What things you need to install the software and how to install them
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn / node / npm
|
||
|
|
```
|
||
|
|
|
||
|
|
## Build Setup
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
# install dependencies
|
||
|
|
yarn
|
||
|
|
|
||
|
|
# serve with hot reload at localhost:3000 (production backend)
|
||
|
|
yarn dev
|
||
|
|
|
||
|
|
# serve with hot reload at localhost:3000 (local backend)
|
||
|
|
yarn dev:local
|
||
|
|
|
||
|
|
# build for production with minification
|
||
|
|
yarn build
|
||
|
|
|
||
|
|
# build for production and view the bundle analyzer report
|
||
|
|
yarn build --report
|
||
|
|
|
||
|
|
# run unit tests
|
||
|
|
yarn unit
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running the tests
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn test
|
||
|
|
```
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn build
|
||
|
|
```
|
||
|
|
|
||
|
|
## Built With
|
||
|
|
|
||
|
|
* [VueJS](https://vuejs.org/) - VueJS
|
||
|
|
* [Vuex](https://github.com/vuejs/vuex) - State management
|
||
|
|
* [Vuei18n](https://github.com/kazupon/vue-i18n) - i18n
|
||
|
|
* [Vue Draggable](https://github.com/SortableJS/Vue.Draggable) - Drag n drop component
|
||
|
|
* [MongoDB](https://www.mongodb.com/) - Database
|
||
|
|
* [IGDB](https://www.igdb.com/) - Game database API (These guys are awesome! Huge open source supporters!)
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please refer to [Issues](https://github.com/romancmx/switchlist/issues) for details on open issues. Any contribution is appreciated.
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/romancmx/switchlist/releases).
|
||
|
|
|
||
|
|
## Authors
|
||
|
|
|
||
|
|
* **Roman** - *Lead Developer* - [Roman](https://twitter.com/romancm)
|
||
|
|
* **Tristan** - *Contributor* - [3stan](https://github.com/3stan)
|
||
|
|
|
||
|
|
See also the list of [contributors](https://github.com/romancmx/switchlist/graphs/contributors) who participated in this project.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|
||
|
|
|
||
|
|
## Acknowledgments
|
||
|
|
|
||
|
|
* The [/r/NintendoSwitch/](https://www.reddit.com/r/NintendoSwitch/) community for great initial poll feedback
|