Skip to content

Commit e56bc3b

Browse files
committed
docs(README): replace setup instructions with local setup guide link
- Remove detailed setup steps from README.md - Add link to Local Setup Guide in official documentation - Guide provides comprehensive, step-by-step instructions for environment setup
1 parent bb79b70 commit e56bc3b

File tree

1 file changed

+2
-27
lines changed

1 file changed

+2
-27
lines changed

README.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -78,34 +78,9 @@ Get started for free and purchase when you're ready to launch!
7878

7979
## 🚀 Getting Started & Running Locally
8080

81-
1. **Ensure Flutter is installed.** (See [Flutter documentation](https://flutter.dev/docs/get-started/install))
82-
2. **Clone the repository:**
83-
```bash
84-
git clone https://github.com/flutter-news-app-full-source-code/flutter-news-app-web-dashboard-full-source-code.git
85-
cd flutter-news-app-web-dashboard-full-source-code
86-
```
87-
3. **Get dependencies:**
88-
```bash
89-
flutter pub get
90-
```
91-
4. **Run the app:**
92-
93-
To run the app, first select your desired environment in `lib/main.dart`:
81+
For a complete guide on setting up your local environment, running the web dashboard, and understanding the configuration, please see the **[Local Setup Guide](https://flutter-news-app-full-source-code.github.io/docs/web-dashboard/local-setup/)** in our official documentation.
9482

95-
```dart
96-
// lib/main.dart
97-
98-
// Use `AppEnvironment.demo` to run with in-memory data (no API needed).
99-
// Use `AppEnvironment.development` to connect to a local backend API.
100-
// Use `AppEnvironment.production` to connect to a live backend API.
101-
const appEnvironment = AppEnvironment.demo;
102-
```
103-
104-
Then, run the app from your terminal:
105-
```bash
106-
flutter run -d chrome
107-
```
108-
*(Note: For `development/production` environment, ensure the [backend service](https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code) is running.)*
83+
Our documentation provides a detailed, step-by-step walkthrough to get you up and running smoothly.
10984

11085
---
11186

0 commit comments

Comments
 (0)