Skip to content

Commit

Permalink
added gif demo
Browse files Browse the repository at this point in the history
  • Loading branch information
fulanii committed Dec 19, 2024
1 parent c99d55e commit 35bd13b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
Binary file added autoapp_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 3 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Autoblue
Autoblue is an open-source web app for automating posts on [Bluesky](bsky.app), thanks to the [Bluesky](bsky.app) python api.

## Demo
[![Autoblue demo](./autoapp_demo.gif)

## Curent Features
* User registration and login.
* Password change, (Autoblue) account deletion.
Expand All @@ -25,37 +28,30 @@ Autoblue is an open-source web app for automating posts on [Bluesky](bsky.app),
* Task Queue: Celery & Redis
* Deployment: GitHub Actions for CI/CD, DigitalOcean Droplet


## Installation
For this app to run locally make sure you have `celery` and `redis` installed and setup. Use `auto_app.utils.generate_secret_key()` to generate a key using for encrypting your Bluesky username & password. And get a Django secret key using Django shell, add all those in `.env.example`

1. Clone the repository:
```bash
git clone https://github.com/fulanii/autoblue.git
cd autoblue
```

2. Set up a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```

3. Install dependencies:
```bash
pip install -r requirements.txt
```

4. Run the development server:
```bash
export DJANGO_ENV=development
celery -A auto_app.celery:app worker --loglevel=info
python manage.py migrate
python manage.py runserver
```

5. Set up postgres db, add your credentianls in .env.example

6. Access the app at http://127.0.0.1:8000/.

## Usage
Expand Down

0 comments on commit 35bd13b

Please sign in to comment.