Skip to content

maxpou/dictionary-game

Repository files navigation

Dictionary Game

Build Status Standard - JavaScript Style Guide tested with jest Greenkeeper badge

A small web app to improve my english vocabulary.

screenshots

What's Included:

Based on vue-cli 3 and follow his file structure/conventions.

Firebase

This application use Firebase for Authentication and Data storage.
In this project, I use 2 project to separate environments:

API ENDPOINTS Environment
https://translate-2f28d.firebaseio.com/ Production
https://translate-test-aee8f.firebaseio.com/ Dev / Test

Database access rules:

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "$uid === auth.uid",
        ".write": "$uid === auth.uid"
      }
    }
  }
}

Data structure:

β”œβ”€β”€ users/
β”‚   └── {userID}/
|       └── words/
β”‚           β”œβ”€β”€ {wordId}/
β”‚               // example of a word:
β”‚               {
β”‚                 content: "a word",
β”‚                 enabled: true,
β”‚                 translation: "a word translation"
β”‚               }

Notes:

Dev tools

Available commands:

  • npm run serve: start a mini HTTP server
  • npm run build build for production
  • npm run lint: lint code
  • npm test: run unit tests

More information in the official documentation

Deployment

This app is hosted by Github Pages and the Deployment is fulfilled by Travis CI (lint+tests must be green).

Icons

Icons made by Flat Icons.