Skip to content

Commit

Permalink
docs: add docs for how to hack on the project
Browse files Browse the repository at this point in the history
  • Loading branch information
danihodovic committed Nov 6, 2022
1 parent b8387a8 commit 2eff024
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,42 @@ When going to **production** you should run ```python manage.py collectstatic```
![Sign Up](./images/signup.png)
![Password Reset](./images/password_reset.png)

## Generating screenshots
### Generating screenshots

```
convert "$1" -crop 1072x901+436+200 crop_signin.png
```

### Hacking on the project

```sh
# Clone the repo
git clone [email protected]:danihodovic/django-allauth-ui.git
cd django-allauth-ui.git

# Create the virtual env
python -m venv .venv
# Activate the virtual env. This has to be done every time you enter the directory.
source .venv/bin/activate

# Install the dependencies
pip install --upgrade pip poetry
poetry install

# Install tailwind
npm install

# Run the migrations
./manage.py migrate

# Add sample social providers
./manage.py create_test_providers

# Start the server
./manage.py runserver_plus

# Start the tailwind compilation process
npm run-script build:watch
```

Make changes in allauth_ui/templates and open the browser at http://localhost:8000/accounts/login/

0 comments on commit 2eff024

Please sign in to comment.