Skip to content

Commit b1f2b6c

Browse files
committed
docs(README): replace local setup instructions with documentation link
- Removed detailed setup steps from README.md - Added link to official documentation for complete setup guide - Streamlined content for better readability and maintenance
1 parent c3c1108 commit b1f2b6c

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
@@ -76,34 +76,9 @@ Get started for free and purchase when you're ready to launch!
7676

7777
## 🚀 Getting Started & Running Locally
7878

79-
1. **Prerequisites:**
80-
* Dart SDK (`>=3.0.0`)
81-
* MongoDB (`>=5.0` recommended)
82-
* Dart Frog CLI (`dart pub global activate dart_frog_cli`)
79+
For a complete guide on setting up your local environment, running the server, and understanding the configuration, please see the **[Local Setup Guide](https://flutter-news-app-full-source-code.github.io/docs/api-server/local-setup/)** in our official documentation.
8380

84-
2. **Clone the repository:**
85-
```bash
86-
git clone https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code.git
87-
cd flutter-news-app-api-server-full-source-code
88-
```
89-
90-
3. **Configure your environment:**
91-
Copy the `.env.example` file to a new file named `.env`:
92-
```bash
93-
cp .env.example .env
94-
```
95-
Then, open the new `.env` file and update the variables with your actual configuration values (e.g., `DATABASE_URL`).
96-
97-
4. **Get dependencies:**
98-
```bash
99-
dart pub get
100-
```
101-
102-
5. **Run the development server:**
103-
```bash
104-
dart_frog dev
105-
```
106-
The API will be available at `http://localhost:8080`. On startup, the server will connect to your MongoDB database and seed it with initial data. This process is idempotent, so it can be run multiple times without creating duplicates.
81+
Our documentation provides a detailed, step-by-step walkthrough to get you up and running smoothly.
10782

10883
---
10984

0 commit comments

Comments
 (0)