Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update usage docs #9

Open
dantownsend opened this issue Nov 19, 2024 · 0 comments
Open

Update usage docs #9

dantownsend opened this issue Nov 19, 2024 · 0 comments

Comments

@dantownsend
Copy link
Member

The current usage docs are OK for contributors, but this isn't how end users will use it.

### Usage
Clone repository.
```bash
git clone https://github.com/piccolo-orm/piccolo-admin-docker.git
```
Creating an `.env` file.
```bash
cp .env.example .env && rm .env.example
```
Run the Docker container.
```bash
docker-compose up -d
```
After site is running log in as admin user on [localhost:8000](http://localhost:8000) and use legacy database.
Stop the Docker container.
```bash
docker-compose down
```

End users will not clone this repo - they will get the Docker image from Docker Hub, and just run it.

Something like:

docker run piccolo/piccolo_admin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant