Burplist Frontend

What is this?

A frontend repository for https://burplist.com built using PyWebIO.

The site serves as a search engine for craft beers in Singapore, providing craft beer lovers pricing information for their favorite beer.

I have documented some of my thought process and engineering decisions while creating Burplist here. Enjoy!

Development

Requirements

• Python 3.9+
• poetry
• PostgreSQL

Database

• Make sure you have a running instance of the latest PostgreSQL in your local machine

• Example to spin up a PostgreSQL Docker instance locally

  docker run -d --name dpostgres -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:latest

• Create a new database name as burplist

• Ensure that pg_trgm is installed as your PostgreSQL extension

  CREATE EXTENSION pg_trgm;

How to install

poetry install

# Installing dependencies only
poetry install --no-root

# Updating dependencies to their latest versions
poetry update

Setup Pre-commit Hooks

Before you begin your development work, make sure you have installed pre-commit hooks.

Some example useful invocations:

• pre-commit install: Default invocation. Installs the pre-commit script alongside any existing git hooks.
• pre-commit install --install-hooks --overwrite: Idempotently replaces existing git hook scripts with pre-commit, and also installs hook environments.

Optional: Environment variables

Check out /src/settings.py and configure them accordingly.

Usage

How to run locally

poetry run python3 app.py --debug=True --port=8080
# At `http://localhost:8080/`

Start your database

You'll need to setup your Postgres locally based on the instructions here. And then run:

docker start dpostgres

Optional: Using Docker

# build docker image.
make build

# run local development server in docker.
make run

Your server should be live at to http://localhost:8080.

Deployment

This project is currently hosted on Heroku.

Optional: Useful Heroku commands

heroku git:remote -a burplist-frontend-staging --staging

# Print logs for staging
heroku logs --tail --remote staging

# Print logs for production
heroku logs --tail --remote heroku

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Steps

1. Fork this
2. Create your feature branch (git checkout -b feature/bar)
3. Please make sure you have installed the pre-commit hook and make sure it passes all the lint and format check
4. Commit your changes (git commit -am 'feat: add some bar', make sure that your commits are semantic)
5. Push to the branch (git push origin feature/bar)
6. Create a new Pull Request