codex-frontend/README.md

49 lines
978 B
Markdown
Raw Normal View History

2023-10-24 15:29:35 -05:00
# Codex Frontend
A frontend for codex made with Flutter.
2023-10-24 15:29:35 -05:00
## Features
- Upload multiple files at once
- Dockerize frontend
- Show status of locally running codex node
2023-10-26 22:43:11 -05:00
- Upload to codex nodes
2023-11-24 12:09:56 +09:00
- View file Uploaded
2023-11-24 12:03:54 +09:00
- Download from codex nodes
- Now supports marketplace endpoints!
2023-10-24 15:29:35 -05:00
2023-10-24 15:29:35 -05:00
## Planned Features
- Show status of connection to codex peers
2023-11-24 12:09:56 +09:00
- Settings for the connection
2023-10-24 15:29:35 -05:00
2023-11-24 12:08:10 +09:00
## How to run it
1. Clone repository
```shell
git clone https://github.com/codex-storage/codex-frontend
cd codex-frontend
```
2. Grab your codex api link and define a variable for docker compose file
```shell
export codex_url="http://localhost:8080"
```
3. Run codex frontend
```shell
docker compose up
```
2023-11-24 12:08:10 +09:00
4. Go to [localhost:3000](http://localhost:3000)
2023-10-24 15:29:35 -05:00
## Screenshots
![Data page: Upload](screenshots/upload-page.png)
![Data page: Upload (with uploads)](screenshots/upload-page-uploads.png)
![Data page: Download](screenshots/download-page.png)