Git Product home page Git Product logo

flashcard-game's Introduction

Documentation

Build Instructions

Basic Build

sudo docker-compose up

Full Rebuild

sudo docker container prune && sudo docker-compose up --build

Architecture

Backend

Flask is used for the backend, with itself and other dependencies installing via requirements.txt. Outside docker this can be utilized using pip install -r requirements.txt

Frontend

NPM is used for the frontend dependencies. Outside of docker, these can be installed using npm install Webpack is used to package everything together, it also manages transpiling. The package.json is used to specify the watch proccess for this. To watch files with webpack outside of Docker, run npm run watch.

Production

Currently no settings have been made for a production environment - this is a work in progress. Results of this build should be taken using a multi-stage build process - no docker-compile.yml file should be used.

TODO

The database also currently wipes itself for every build - have a set of test migrations would be helpful. Testing also needs to be done.

flashcard-game's People

Contributors

chrismott97 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.