Skip to content

Latest commit

 

History

History
192 lines (147 loc) · 5.46 KB

README.md

File metadata and controls

192 lines (147 loc) · 5.46 KB
Raw

WWW2PNG

Build Status Requirements Status Status Uptime Twitter Follow

This is the primary codebase for the www2png web application.

WWW2PNG is a free webpage screenshot service API with blockchain anchoring using RigidBit and Ethereum.

Development Prerequisites

Before developing on this application you should have working knowledge of the following technologies and toolchains:

You should also have working experience with the following frameworks and libraries:

You must have the following installed in your development environment to properly build:

Development Server Prerequisites

Production Server Prerequisites

Production Server Fonts

Websites in languages that do not use Roman characters may require additional fonts to display correctly. The fonts DejaVu and Noto are free fonts that can be installed which handle many of the common languages.

Development Setup

Supported Platforms

Ubuntu Linux 18.04 is the official development environment, however it may also work with other environments.

Basic Webserver Setup Procedure

  • Configure all server prerequisites.
  • Create a web directory and create an initialized venv directory within it.
  • Install dependencies within the venv.
  • Populate .env with secrets and settings.
  • Configure PostgreSQL server with a new database, user, and install the tables from dev/sql/create_tables.sql.
  • Configure webserver to use WSGI with the venv and serve static content from the static directory.

Developing

The steps below outline how to setup and start the development environment. This is different than production!

Using a venv is highly recommended.

python -m venv init venv
source venv/bin/activate

Installing dependencies from requirements.txt:

pip install -r requirements.txt

Saving dependencies to requirements.txt:

Using pipreqs is recommended over pip. While in an active venv use the following to regenerate requirements.txt.

pipreqs --ignore node_modules --force

Setting up the .env file:

See README_ENV.md for a basic template.

Creating symbolic links:

Symbolic links will need to be setup from the src directory to the corresponding folders in the project root.

ln -s ../data src/data
ln -s ../static src/static

Starting the development server:

npm run flask

or

FLASK_APP=src/web.py FLASK_DEBUG=1 python -m flask run -h 0.0.0.0 -p 5000

Starting the development CSS builder:

npm start

Starting the pruning service:

python3 pruner.py

Starting the processing service:

python3 processor.py

Starting the aciton processing service:

python3 action_processor.py

Deploying to Production

Building static assets for production:

This builds all static CSS assets and puts them in the static folder.

npm build

Web:

Copy the following files and folders to the remote server.

www2png/*.py
www2png/templates/*
static/*
requirements.txt
uwsgi.ini

Create the following empty folders.

data

Create symbolic links.

ln -s ./data www2png/data
ln -s ./static www2png/static

Create a venv and install the requirements.

python -m venv init venv
source venv/bin/activate
pip install -r requirements.txt

Configuring the web server:

Setup your webserver to serve static content from the static folder. All other requests should be sent to the uWSGI handler.

See README_NGINX.md for a basic Nginx configuration example.

Setting up services:

You will need to also setup services for:

  • action_processor.py
  • processor.py
  • pruner.py
  • uwsgi.py

You can use any service manager, but systemd is recommended. See README_SERVICES.md for a basic configuration examples.

Testing

Setup the venv, symlinks, and database as noted above. The .env will need to be populated with valid settings. The webserver and uWSGI is not needed for testing.

To launch tests execute the following command from the project root:

npm run test

or

python -m unittest discover tests