An open API service indexing awesome lists of open source software.

https://github.com/alexdredmon/notchbegone

Notchless background generator (React/Python)
https://github.com/alexdredmon/notchbegone

background generator image notch python react

Last synced: about 1 month ago
JSON representation

Notchless background generator (React/Python)

Awesome Lists containing this project

README

          

# Notch Be Gone 💻
[![Build, Test, & Deploy](https://github.com/alexdredmon/notchbegone/actions/workflows/firebase-hosting-merge.yml/badge.svg)](https://github.com/alexdredmon/notchbegone/actions/workflows/firebase-hosting-merge.yml)

Dress up your notch with a smart looking dark title bar, custom tailored to your image - no installation required.

https://notchbegone.com

## Requirements

- [Yarn](https://yarnpkg.com/en/) - Builds and runs frontend application

- [Docker Desktop](https://www.docker.com/products/docker-desktop) - Builds and runs API container

## Setup

1. (Optional) Build API container (you can alternatively point to the production API in web/.env)

```bash
docker-compose build
docker-compose up api
```

2. Build frontend application

```bash
cd web
yarn
```

3. Run frontend application

```bash
yarn start
```

4. (Optional) Run frontend tests

```bash
cd web
yarn test
```

## Demo

When run, the app should look like this:

![Notch Be Gone](https://user-images.githubusercontent.com/20774517/151737126-0e4940ad-3938-4055-ad47-95891b5c0925.png)

![Notch Be Gone Settings](https://user-images.githubusercontent.com/20774517/151737127-8bb83dc7-4fa5-44fa-ad90-8372532d8006.png)