/code-challenge-wagtail

Boilerplate code for a Wagtail coding challenge

Primary LanguagePython

Coding Challenge - Wagtail

Repository for the coding challenge.

Prompt

Backstory

At the company Widgets and More, we pride ourselves making the best widgets in the industry and for all your widgety needs. However, in this day and age, one needs a digital presence in order to get the word out about our wonderful widgets, any information and documentation regarding said widgets, and ways to interact with our widget-buying customers and clients.

With a launch of the newest and shiniest Widget, yet, we need to get the news out there and need a new type of page in our content management system (CMS).

Task at Hand

Time Limit: 90 minutes

Requirements:

  • Create a WidgetDocumentation within the Wagtail CMS. This page type should be able to handle a title, description, and body content as rich text.

  • Since the documentation page can become rather long, we'll want a table of contents at the top of the page that can deeplink to the different major sections/headings

Development Environment

Requirements

  • Python > 3.8

Setup

  1. (Optional but recommended) Create a virtual environment and activate it

    python -m venv venv
    source ./venv/bin/activate
  2. Install dependencies

    pip install -r requirements.txt
  3. Install browsers for Playwright

    playwright install
  4. Get the server up and running

    python manage.py runserver
  5. Manually test the site in a browser at http://localhost:8000

  6. Test Playwright (automated testing framework) is working

    pytest
  7. Assuming steps 4 and 5 worked for you, you're all set! 🎉

Notes

  • Super User Login (username/password): admin/admin

  • To stop the server, use ctrl + c or cmd + c

  • To deactivate your environment

    deactivate

Reference Links