ErickGallani/lunchticketcontrol

A simple lunch ticket control application with qCode generation.

Lunch Ticket Application

• Lunch ticket control application with qrCode generation.

Requirements

• Python3
• Pip
• Virtualenv
• NodeJS

Specification for the API design

• JsonApi
• REST Design
• Swagger Spec

Installation / Usage

• Install Python & Pip on windows

  • https://github.com/BurntSushi/nfldb/wiki/Python-&-pip-Windows-installation

• Ensure you have python3 globally installed in your computer.

• After this, ensure you have installed virtualenv globally as well. If not, run this:

  $ pip install virtualenv
  

• Install the requirements

  (venv)$ pip install -r requirements.txt
  

• Migrations

  Migrations commands

  (venv)$ python manage.py db init (creates a new migrations folder)
  

  (venv)$ python manage.py db migrate --message "your message" (creates a new migration file)
  

  Migrate your migrations to persist on the DB

  (venv)$ python manage.py db upgrade (apply the migrations to the database)
  

• Running It

  On your terminal, run the server using this one simple command:

  (venv)$ export SENTRY_DSN="https://public_key:private_key@sentry.io/project_id"
  (venv)$ python run.py
  

  You can now access the app on your local browser by using

Documentation

• Backend

  • Flask
  • Flask Restful and Swagger
  • Flask-SQLAlchemy
  • Flask-Alembic
  • Flask-Swagger-UI
  • Flask-JWT
  • SQLAlchemy
  • Alembic
  • PyQRCode
  • Marshmallow

• Frontend

  • ReactJS
  • NodeJS
  • WebPack
  • TypeScript
  • CSS Module
  • Jest
  • Enzyme

• For Logging

  • Sentry

Developer Tools

• React Developer Tools
  • https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en
• Redux Developer Tools
  • https://github.com/zalmoxisus/redux-devtools-extension
• Python Notebook (Jupyter)
  • This is a excelent tool for real time python code and inspec
  • Jupyter

To generate SSL Certificate

• Using pyOpenSSL (NOTE: Do NOT install this python lib on the project virtual env)
  • Command

  $ pip install pyopenssl
  $ openssl req -x509 -sha256 -nodes -newkey rsa:2048 -days 365 -keyout localhost.key -out localhost.crt
  

For Visual Studio Code users

• To be able to debug the application inside visual studio code change the file launch.json inside .vscode locate the section configurations add the following config

  {
      "name": "Python: Flask Lunch Ticket app",
      "type": "python",
      "request": "launch",
      "stopOnEntry": false,
      "pythonPath": "${config:python.pythonPath}",
      "program": "${workspaceFolder}/server/run.py",
      "cwd": "${workspaceFolder}/server",
      "args": [],
      "env": {},
      "envFile": "${workspaceFolder}/.env",
      "debugOptions": [
          "RedirectOutput"
      ]
  }
  

• Inside the run.py set the debug to false to prevent conflict between visual studio debug runner and werkzeug (flask runner) Eg.: debug=False

For windows users using pycharm

• If you are on the windows environment and want to use cmder with pycharm you can do
• Create a environment variable

  CMDER_ROOT = C:\cmder (for example)
  

• On pycharm edit the terminal shell path like this

  "cmd.exe" /k ""%CMDER_ROOT%\vendor\init.bat"" is important have all the quotes