Skip to content

Commit 2428c58

Browse files
committed
doc: Create setup guide
1 parent 141d8f2 commit 2428c58

File tree

1 file changed

+10
-89
lines changed

1 file changed

+10
-89
lines changed

docs/setup.md

Lines changed: 10 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,14 @@
1-
# Setup
1+
# Dev setup
22

3-
## Prerequisites
3+
For general instructions on setting up to do development on this Flutter-based Zulip mobile app, [see the README][readme-link].
4+
This file covers specific topics in more detail.
45

5-
Before you begin, you need to setup development environment:
6+
[readme-link]: https://github.com/zulip/zulip-flutter?tab=readme-ov-file#setting-up
67

7-
1. **Flutter SDK**
8-
- Follow the [Flutter installation guide](https://docs.flutter.dev/get-started/install) for your platform of choice.
9-
- Switch to the latest version of Flutter:
10-
```bash
11-
flutter channel master
12-
flutter upgrade
13-
```
14-
- Ensure Flutter is correctly configured
15-
```bash
16-
flutter doctor
17-
```
18-
19-
20-
### Flutter version
21-
22-
While in the beta phase, we use the latest Flutter from Flutter's
23-
main branch. Use `flutter channel main` and `flutter upgrade`.
24-
25-
We don't pin a specific version, because Flutter itself doesn't offer
26-
a way to do so. So far that hasn't been a problem. When it becomes one,
27-
we'll figure it out; there are several tools for this in the Flutter
28-
community. See [issue #15][].
29-
30-
[issue #15]: https://github.com/zulip/zulip-flutter/issues/15
318

9+
## On a cloud server
10+
For setting up the development environment on a linux server, aside from the normal setup
11+
you need to consider some specific requirements.
3212

3313
### Java version for Android
3414

@@ -41,70 +21,11 @@ version installed to work on the project smoothly and without issues.
4121
[Android SDK]: https://developer.android.com/tools
4222
[JDK 17]: https://www.oracle.com/java/technologies/downloads/?er=221886#java17
4323

44-
### Sqlite setup for linux
24+
### Sqlite setup
4525

46-
If you're working on Linux you'll need to setup sqlite3 if it is not
47-
already set up.
26+
If you're using Linux, you'll need to setup sqlite3 if it is not already set up.
4827

28+
On Ubuntu that'd be:
4929
```bash
5030
sudo apt-get install sqlite3 libsqlite3-dev
5131
```
52-
53-
## Getting Started
54-
55-
### 1. Clone the Repository
56-
57-
```bash
58-
git clone https://github.com/zulip/zulip-flutter.git
59-
cd zulip-flutter
60-
```
61-
62-
### 2. Install Dependencies
63-
64-
Run the following command to fetch the Flutter dependencies:
65-
66-
```bash
67-
flutter pub get
68-
```
69-
70-
### 3. Running the App
71-
72-
To run the app on your local machine, use the following command:
73-
74-
```bash
75-
flutter run
76-
```
77-
78-
Ensure that you have an emulator running or a physical device connected.
79-
80-
81-
### Tests
82-
83-
You can run all our forms of tests with the `tools/check` script:
84-
85-
```
86-
$ tools/check
87-
```
88-
89-
See `tools/check --help` for more information.
90-
91-
The two major test suites are the Dart analyzer, which performs
92-
type-checking and linting; and our unit tests, located in the `test/`
93-
directory.
94-
95-
You can run these suites directly with the commands `flutter analyze`
96-
and `flutter test` respectively. Both commands accept a list of file
97-
or directory paths to operate on, and other options. Particularly
98-
recommended is a command like
99-
```
100-
$ flutter test test/foo/bar_test.dart --name 'baz'
101-
```
102-
which will run only the tests in `test/foo/bar_test.dart`,
103-
and within those only the tests with names matching `baz`.
104-
105-
When editing in an IDE, the IDE should give you the exact same feedback
106-
as `flutter analyze` would. When editing a test file, the IDE can also
107-
run individual tests for you.
108-
See [upstream docs on `flutter test`][flutter-cookbook-unit-tests].
109-
110-
[flutter-cookbook-unit-tests]: https://docs.flutter.dev/cookbook/testing/unit/introduction

0 commit comments

Comments
 (0)