Mirrors/gamebrary
2
0
Fork 0
mirror of https://github.com/romancm/gamebrary synced 2024-11-10 13:44:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Removed old readme

Browse source
This commit is contained in:
Roman Cervantes 2018-10-18 22:36:18 -07:00
parent 21e2c55003
commit 2a2ee68f14
1 changed files with 1 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
README.md
View file

@ -1,83 +1 @@
# SwitchList
![kapture 2018-07-02 at 21 56 24](https://user-images.githubusercontent.com/645310/42199388-21895a4a-7e43-11e8-9959-513a535eea25.gif)
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
# Gamebrary