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

# 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 - VueJS
• Vuex - State management
• Vuei18n - i18n
• Vue Draggable - Drag n drop component
• MongoDB - Database
• IGDB - Game database API (These guys are awesome! Huge open source supporters!)

Contributing

Please refer to Issues for details on open issues. Any contribution is appreciated.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Roman - Lead Developer - Roman
• Tristan - Contributor - 3stan

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• The /r/NintendoSwitch/ community for great initial poll feedback