Metadata-Version: 2.1
Name: oculta
Version: 0.0.1
Summary: Manage payments and game scoring for Oculta escape room game
Home-page: https://gitlab.com/perita/oculta/
Author: David Pérez
Author-email: dperez@peritasoft.com
License: AGPL-3.0-or-later
Description: Oculta
        ======
        
        The basic API for handling payment checking and game scoring.
        
        All commands in the following sections assume the use of Microsoft Power Shell.
        
        
        Install
        -------
        
        Clone the repository and move into the `api` folder.
        
        ~~~~
        git clone https://gitlab.com/perita/oculta
        cd oculta/api
        ~~~~
        
        Create a virtualenv and activate it.
        
        ~~~~
        python -m venv .env
        & .env/Scripts/Activate.ps1
        ~~~~
        
        Install Oculta.
        
        ~~~~
        pip install -e .
        ~~~~
        
        Install required NodeJS packages for Tailwind CSS.
        
        ~~~~
        npm install
        ~~~~
        
        Compile the final CSS styles with Post CSS. Set `NODE_ENV` environment
        variable to `production` to get a pruned version of the style.
        
        ~~~~
        npm run postcss
        ~~~~
        
        
        Run
        ---
        
        Inside the `api` folder with the virtualenv activated.
        
        ~~~~
        $env:FLASK_APP='oculta'
        $env:FLASK_ENV='development'
        $env:FLASK_DEBUG='1'
        flask initdb
        flask run
        ~~~~
        
        Open http://127.0.0.1:5000/ in a browser.
        
        To only test the paypal module run:
        
        ~~~~
        python -m oculta.paypal
        ~~~~
Platform: UNKNOWN
Description-Content-Type: text/markdown
