Skip to content

Commit

Permalink
[#109] Update README: Add commands section
Browse files Browse the repository at this point in the history
  • Loading branch information
ifirmawan committed Nov 12, 2024
1 parent c2b2f5f commit 710c6a0
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Power Awarness Tool
- [Frontend](#frontend)
- [API Documentation](#api-documentation)
- [PgAdmin](#pgadmin)
- [Commands](#commands)
- [Export Users to CSV](#export-users-to-csv)
- [Troubleshooting](#troubleshooting)

## Prerequisites
Expand Down Expand Up @@ -88,6 +90,26 @@ Use the following credentials to log in to PgAdmin:
- **Password**: `password`


## Commands

### Export Users to CSV

This command allows you to export user data from the database to a CSV file. Admin users can then download this file from the **Manage Users** page in the admin panel.

#### Usage

To run the command and generate the CSV file, use the following command in the terminal:

```bash
docker compose exec backend python manage.py export_users_csv
```

#### Details

- **Command**: `export_users_csv`
- **Functionality**: Exports user data from the database into a CSV format.
- **File Location**: The generated CSV file is stored in the `./storage` directory, where it can be accessed via the admin dashboard under the Manage Users page.

---
## Troubleshooting

Expand Down

0 comments on commit 710c6a0

Please sign in to comment.