scape-web

A web-based version of the infinite, spatial text editor, scape.

Pages are accessible via clean URLs (e.g., /my-page).

Local Development

1. Create and activate a Python virtual environment:

   python -m venv venv
   source venv/bin/activate

2. Install Python dependencies:

   pip install -r requirements.txt

3. Run the Flask development server:

   python app.py

4. Open in your browser: Navigate to http://127.0.0.1:5001

Deployment

This application is set up to be run by a production WSGI server like Gunicorn.

1. Install Gunicorn:

   pip install gunicorn

2. Run the application with Gunicorn:

   gunicorn --workers 4 --bind 0.0.0.0:8000 app:app

   This will start the server on port 8000. You would typically run this behind a reverse proxy like Nginx or Caddy.

How to Use

Grid View

• Movement: Use h,j,k,l or Arrow Keys to move the cursor.
• Insert Mode: Press i to enter insert mode for editing the grid. Press Escape to exit.
• Open Page: Place the cursor over a linked word and press Enter. This will navigate to /<word>.
• Command Pallet: Press : to open the command pallet.
  • w: Save the grid.
  • wq or x: Save the grid and attempt to close the browser tab.
  • q: Attempt to close the browser tab.

Page View

• Open: Accessed by pressing Enter on a linked word or navigating directly to /<page-name>.
• Editing: The page is immediately editable.
• Save and Quit: Press Escape to save the page content and return to the main grid view (/).