Table of Contents
Please setup the project as detailed in the getting started section and run locally (by $ gunicorn main:app). The hosting service I am using is incredibly slow, and working on bugs relating to it are not a priortity for me currently.
Julia is a website which allows users to create accounts and then uniquely pair coloured renders of the mandelbrot set to said account.
In the future it would be great to be able to allow a user to zoom into specific parts of the mandelbrot set.
The website is not meant to have practical applications, and is simply a fun project to test myself. The website is currently deployed, however it is highly recommended to run locally as it will avoid errors.
Screenshots
| Landing Page | Generate Page |
|---|---|
 |
 |
I am using the Python Flask framework for all handling of routing and backend logic. The front end of the website is all done in plain HTML, CSS and JavaScript.
The production database is saved on PostgreSQL, with the development db using SQLite.
The rendering of the Mandelbrot set is done entirely in python with the matplotlib library used for visualisation.
Anything not mentioned uses Python.
I tried to experiment with a wide range of testing in this project and attempt to apply best practices in regards to the testing pyramid/mocking/coverage, and so am using a variety of technologies relating to this. Currently I am using pytest/unittest for all integration and unit tests, Playwright for E2E, Selenium for screenshot testing, Mutagen for mutation testing and Coverage.py for measuring the coverage of my tests.
The below diagram does not show all endpoints and functions, but it does show the primary ones relating to displaying and rendering fractals.
.png "Landing Page")
+---------------------------------------+
| User Interface (HTML, CSS, JS) |
+---------------------------------------+
^ ^
| |
v v
+---------------------------------------+
| Flask App |
+---------------------------------------+
| /generate |
| generate() API |
| /mandelbrot/<query params> |
| mandelbrot(slug) | <--> Renders Mandelbrot Set and returns image
+---------------------------------------+
^ ^
| |
v v
+---------------------------------------+
| PostgreSQL |
+---------------------------------------+
| Users Table |
| Fractals Table |
+---------------------------------------+
All you need to get started is to have Python 3.10.9 or later installed on your machine.
$ python -m venv env
$ source env/bin/activate
$ pip install -r requirements.txtCreate a .env file in the root directory and add the following variables:
SECRET_KEY='changethissecretkey'
FLASK_APP='julia/main.py'
DATABASE_URL='sqlite:///database.db'
DEBUG=True
E2E_APP_PORT=5001
To avoid a bug please also run this command in the root directory:
$ export FLASK_APP=main.py$ flask db upgrade
# Only run this next command if the first fails
$ flask db initTo run the website locally, run the following command:
$ gunicorn main:appThe website will then be available at http://localhost:8000/, and you will be able to create an account and generate your own mandelbrot set.
$ pytest -v
$ mutatest
$ coverage run -m pytest -v
$ coverage report -i Make sure that you are running a local instance to allow e2e tests to interface.
If you need any help please feel free to reach out to me at the email address listed on my GitHub profile 😄.
- GitHub issues
- Contact options listed on this GitHub profile