-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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.
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
Reworked getting started experience #800
Changes from 27 commits
d7b4cbb
37a59b8
54f62a5
dafe244
70b6e14
e59fa96
c477f7b
24d0a06
48af134
2a1b6ac
813a45c
ff379aa
5d0c460
11ad3d7
1154ae2
de92a83
70b259d
58741de
07b7329
638bc37
4e9392b
29f1a27
028bede
f147234
3eb1a30
d53dd15
b24bbec
6c058f4
7a3b094
860da34
b81044d
edb40c7
90e0406
2c051b6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
$tab-accent-color: $brand-color; | ||
|
||
// General tabs. These are intended for instructions that vary according to user | ||
// selection, e.g. around editor choice in getting started. | ||
|
||
ul.tabs__top-bar { | ||
margin: 0; | ||
padding: 0; | ||
list-style: none; | ||
} | ||
|
||
ul.tabs__top-bar li { | ||
background: none; | ||
color: $grey-color; | ||
display: inline-block; | ||
padding: 5px 5px; | ||
cursor: pointer; | ||
} | ||
|
||
ul.tabs__top-bar li.current{ | ||
background: $tab-accent-color; | ||
color: $background-color; | ||
} | ||
|
||
.tabs__content{ | ||
display: none; | ||
border: 1px solid $tab-accent-color; | ||
padding: 5px; | ||
margin-bottom: 20px; | ||
} | ||
|
||
.tabs__content.current{ | ||
display: inherit; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,15 +20,24 @@ developers may find it more productive to: | |
The alternative is often tiring formatting debates during code reviews, where | ||
time may be better spent on code behavior rather than code style. | ||
|
||
### Automatically formatting code in IntelliJ | ||
### Automatically formatting code in Android Studio, and IntelliJ | ||
|
||
Automatic formatting of code is supported in IntelliJ if you have the | ||
`Dart` plugin (see [IntelliJ setup](/ide-setup/)). | ||
Install the the `Dart` plugin (see [Editor setup](/get-started/editor/) | ||
to enable automatic formatting of code in Android Studio and IntelliJ. | ||
|
||
To automatically format the code in the current source code window, right-click | ||
in the code window and select `Reformat with Dart style`. You can add a keyboard | ||
shortcut to this in Keymap section of IntelliJ Preferences. | ||
|
||
### Automatically formatting code in VS Code | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. visual studio code , or vs code ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Well, color me wrong. I thought it was "VSCode", but I checked and it's "VS Code". I have to change my docs. :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Microsoft uses both 'Visual Studio Code' and 'VC Code'. I personally much prefer the latter as it's less likely to cause confusion with "big" Visual Studio. |
||
|
||
Install the `Dart-Code` plugin (see [Editor setup](/get-started/editor/) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one has unclosed paren too (also, it suggests editor page has a section in enabling automatic formatting, but I can't see it; though the next paragraph explains how to sort-of-automatically-but-not-on-type format). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fidex |
||
to enable automatic formatting of code in VS Code. | ||
|
||
To automatically format the code in the current source code window, right-click | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. VS Code has some settings that are probably relevant here:
All of these should work with Dart Code and I think we should encourage people to turn them on (they can do so globally, or just for Dart by using language-specific settings). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||
in the code window and select `Format Document`. You can add a keyboard | ||
shortcut to this VS Code Preferences. | ||
|
||
### Automatically formatting code with the `flutter` command | ||
|
||
You can also automatically format code in the command line interface (CLI) using | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
--- | ||
layout: page | ||
title: "Get Started: Configure Editor" | ||
permalink: /get-started/editor/ | ||
--- | ||
|
||
You can build apps with Flutter using any text editor combioned with our | ||
command-line tools. However, we recommend using one of our editor plugins for an | ||
even better experience. With our editor plugins, you get code completion, syntax | ||
highlighting, widget edditing assists, run & debug support, and more. | ||
|
||
Follow the steps before to add an editor plugin for Android Studio, IntelliJ, or | ||
VS Code. If you want to use a different editor, that's OK, simply skip ahead to | ||
[Next step: Create and run your first app](/get-started/test-drive/). | ||
|
||
<ul class="tabs__top-bar"> | ||
<li class="tab-link current" data-tab="tab-install-androidsstudio">Android Studio</li> | ||
<li class="tab-link" data-tab="tab-install-vscode">VS Code</li> | ||
</ul> | ||
|
||
<div id="tab-install-androidsstudio" class="tabs__content current" markdown="1"> | ||
|
||
## Android Studio setup | ||
|
||
*Android Studio:* A complete, integrated IDE experience for Flutter. | ||
|
||
### Install Android Studio | ||
|
||
* [Android Studio](https://developer.android.com/studio/index.html), version 3.0 or later. | ||
|
||
Alternatively, you can also use IntelliJ: | ||
|
||
* [IntelliJ IDEA Community](https://www.jetbrains.com/idea/download/), version 2017.1 or later. | ||
* [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/), version 2017.1 or later. | ||
|
||
### Install the Flutter and Dart plugins | ||
|
||
Flutter is supported by two plugins: | ||
|
||
* The `Flutter` plugin powers Flutter developer workflows (running, | ||
debugging, hot reload, etc.). | ||
* The `Dart` plugin offers code analysis (code validation as you type, code | ||
completions, etc.). | ||
|
||
To install these: | ||
|
||
1. Start Android Studio. | ||
1. Open plugin preferences (**Preferences>Plugins** on macOS, | ||
**File>Settings>Plugins** on Windows & Linux). | ||
1. Select **Browse repositories…**, select the Flutter plug-in and click | ||
`install`. | ||
1. Click `Yes` when prompted to install the Dart plugin. | ||
1. Click `Restart` when prompted. | ||
|
||
</div> | ||
|
||
<div id="tab-install-vscode" class="tabs__content" markdown="1"> | ||
|
||
## Visual Studio Code (VS Code) setup | ||
|
||
*VS Code:* A light-weight editor with Flutter run and debug support. | ||
|
||
### Install VS Code | ||
|
||
* [VS Code](https://code.visualstudio.com/), version 1.19 or later. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Currently we need 1.20.1 but we also bump along with Code updates pretty frequently (since things in Code change quite frequently) so it might be best not to mention this (or encourage latest stable)? Unlike with some IDEs, I don't think updating Code is a big deal (it doesn't bring new versions of .NET, for ex like Visual Studio does) so users probably won't be reluctant to do it (I think it auto-updates by default on all platforms too?). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just updated it to 1.20.1. Would be nice if you could help update this when you take a new version dependency. |
||
|
||
### Install the Dart Code plugin | ||
|
||
1. Start VS Code | ||
1. Invoke **View>Command Palette...** | ||
1. Type 'install', and select the **'Extensions: Install Extension'** action | ||
1. Enter `dart code` in the search field, select 'Dart Code' in the list, and | ||
click **Install** | ||
1. Select 'OK' to reload VS Code | ||
|
||
## Validate your setup with the Flutter Doctor | ||
|
||
1. Invoke **View>Command Palette...** | ||
1. Type 'doctor', and select the **'Flutter: Run Flutter Doctor'** action | ||
1. Review the output in the 'OUTPUT' pane for any issues | ||
|
||
</div> | ||
|
||
## Next step | ||
|
||
Let's take Flutter for a test drive: create a first project, run it, and | ||
experiencee 'hot reload'. | ||
|
||
[Next step: Test drive Flutter](/get-started/test-drive/) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
layout: page | ||
title: "Get Started: Overview" | ||
permalink: /get-started/ | ||
--- | ||
|
||
Welcome to the Flutter Get Started Experience. We will help you: | ||
|
||
* Install the Flutter framework | ||
* Install the dependencies of the Flutter framework | ||
* Create, run, and make changes to your first Flutter app | ||
* Learn core Flutter concepts through a small step-by-step lesson | ||
* Suggest some next steps | ||
|
||
## Next step | ||
|
||
[Next step: Install Flutter](/get-started/install/) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: page | ||
title: "Get Started: Learn More" | ||
permalink: /get-started/learn-more/ | ||
--- | ||
* Learn more about the Flutter framework | ||
|
||
{% comment %} | ||
Once the "Flutter for React" doc (etc) are done, add here. | ||
{% endcomment %} | ||
|
||
* [Building Layouts in Flutter](/tutorials/layout/) tutorial | ||
* [Add Interactivity](/tutorials/interactive/) tutorial | ||
* [A Tour of the Flutter Widget Framework](/widgets-intro/) | ||
* [Flutter for Android Developers](/flutter-for-android/) | ||
|
||
|
||
* Other resources | ||
|
||
* [Flutter Cookbook](/cookbook/) | ||
* [From Java to Dart](https://codelabs.developers.google.com/codelabs/from-java-to-dart/#0) codelab | ||
* [Bootstrap into Dart: learn more about the language](/bootstrap-into-dart/) | ||
|
||
Please reach out to us at our [mailing list][mailinglist]. We'd love | ||
to hear from you! | ||
|
||
Happy Fluttering! | ||
|
||
[mailinglist]: mailto:flutter-dev@googlegroups.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line has an unclosed paren
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed