/GeekScore-2

A PWA for board games fans. It allows you to store your games, create teams and collect statistics. Build with MEVN stack, using Vue.js 2 and Vuetify.

Primary LanguageVue

Geek Score

A PWA for board games fans. It allows you to store your games, create teams and collect statistics. Build with MEVN stack. https://geekscore.herokuapp.com/

This is a second version of the app. The first one is up and running http://geekscore.netlify.com/. Source code of the first version could be found here: https://github.com/DavidGolodetsky/GeekScore-1 The main difference for now is that the first version is using Firebase as a backend, while the second version is written with Node.js and Mongo DB. The idea is that both version would exist in the future, but the second one would be continuously improved, while the first one would be sealed.

For contributors:

Requirements

  • node (preferably >=14)
  • npm

How to contribute?

  1. If you're about to work on particular issue, ask for assignment in order to notify other developers that you're working on that.
  2. Fork repo
  3. Clone your fork
  4. Go to root folder
  5. Run npm i
  6. Start Backend: run npm run serve
  7. Go to client folder and run npm i
  8. Start Frontend: run npm run serve in the client folder
  9. Create your branch, commit, push, create pull request

Project structure

Main logical parts are Games, Teams, Rounds and Users. Those 4 entities could be find all over the project structure.

Backend is writtenn in Node.js (Express) and it's using MongoDB as a database (hence MEVN stack). Index file is server.js in the root folder. Here all routes are applied. Routes could be found in the routes/api folder. They are divided by 4 logical entities. Every route has it's Mongoose schema. All Mongoose models could be found in the models folder (again they are divided on those 4 entities). Firebase is using only for authentication and it's temprary solution before migrating authentication to node.js.

Frontend is written on Vue.js (^2.6). We're also using Vuetify as a UI library, and Vuex as state management library. For routing we're using Vue Router and Vue Test Utils (based on Jest) for unit tests. Frontend index point is main.js. Pages could be found in views folder, components are in components folder. For structuring components we're stick to official Vue styleguide (https://vuejs.org/v2/style-guide/#Tightly-coupled-component-names-strongly-recommended). Vuex store is the heart of the app. All api calls are going through vuex. It's also devided by main 4 entities. All manipulations with the store must go through actions, which will call respective mutations (More info: https://vuex.vuejs.org/guide/actions.html).