Skip to content

update README #8

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.

Sign up for GitHub

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

Merged
clemensfreitagdev merged 1 commit into from
Oct 17, 2025
Merged

update README #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 8 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# CSA Flutter Demo

Simple showcase for Flutter on Codesphere using the default Flutter Application template.

## Development Setup

### Prerequisites
- Flutter SDK (>=3.0.0)
- Dart SDK (>=3.0.0)

### Running the Application
### Running the Application locally

1. **Start the Frontend (Development):**
```bash
Expand All @@ -16,20 +18,10 @@
```
Frontend will be available at `http://localhost:8080`

### Building for Production

1. **Build Frontend:**
```bash
cd frontend
flutter build web
```
Static files will be generated in `frontend/build/web/`

2. **For Codesphere Deployment:**
- The `ci.yml` prepare step runs `flutter build web` in the frontend directory
- Both services run on port 3000 with path-based routing:
- Frontend static files: `/`
- Backend API: `/api/*`
### Running in Codesphere

## API Endpoints
#### Development

- The `ci.demo.yml` prepare step installs Flutter
- The run step starts the Flutter development server (`flutter run -d web-server`)
- Execute both prepare and run step and use `Open Deployment`