LICENSE Documentation

1. Project Overview & Quickstart (leoafarias/LICENSE) Copy Chapter

LICENSE

Open-source repository leoafarias/LICENSE

Repository Details Copy Section

• Repository: leoafarias/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (leoafarias/website) Copy Chapter

[Flutter][]'s website ![Flutter logo][]

Table of contents Copy Chapter

• Issues, bugs, and requests
• Before you build this site
  • 1. Get the prerequisites
  • 2. Clone this repo and its submodules
  • 3. Run installation scripts
• Developing and serving changes
• Creating and/or editing DartPad example code
  • DartPad example code in GitHub gists
  • DartPad example code in this repo - src/_packages/dartpad_picker
• Deploy to a staging site
  • Alternate deployment script
• Deploying to the official site
• Writing for flutter.dev

Issues, bugs, and requests Copy Chapter

We welcome contributions and feedback on our website!
Please file a request in our
issue tracker
and we'll take a look.

NOTE: For simple changes (such as to CSS and text), you probably don't need to
build this site. Often, you can make changes using the GitHub UI.
If you want/need to build, read on.

Before you build this site Copy Chapter

1. Get the prerequisites Copy Section

Install the following tools, if you don't have them already.

• bash, the Bourne shell. These instructions assume you're using bash -- setup might not work if you use another shell.

• nvm, the Node Version Manager.

  NOTE: To make nvm immediately available in your current shell, run source . For example:

  console Copy

  $ source ~/.nvm/nvm.sh

• rvm, the Ruby Version Manager.

  NOTE: To make rvm immediately available in your current shell, run source . For example:

  console Copy

  $ source ~/.rvm/bin/rvm

• Flutter (You get Dart when you get Flutter. Confirm with
  which flutter and which dart.)

• GNU diffutils version 3.6 or later.

  NOTE: diff v3.6+ is required to ensure that in-page code diffs are
  consistently refreshed across macOS and Linux. Issue #3076 was due to
  the default macOS diff being at v2.x. To upgrade diffutils, run:

  console Copy

  $ brew install diffutils

IMPORTANT: Follow the installation instructions for each of the tools
carefully. In particular, configure your shell/environment so
that the tools are available in every terminal/command window you create.

2. Clone this repo _and_ its submodules Copy Section

NOTE: This repo has git submodules, which affects how you clone it.

To clone flutter/website (this repo), follow the instructions given in the
GitHub help on Cloning a repository, then choose one of the following
submodule-cloning techniques:

• Clone this repo and its submodule at the same, use the
  --recurse-submodules option:

  console Copy

  $ git clone --recurse-submodules https://github.com/flutter/website.git

  OR

• If you've already cloned this repo without its submodule, then run
  this command from the repo root:

  console Copy

  $ git submodule update --init --remote

NOTE: At any time during development you can use the git submodule command to
refresh submodules:

console Copy

$ git pull; git submodule update --init --remote

3. Run installation scripts Copy Section

NOTE: It is safe to (re-)run all of the commands and scripts given below even
if you already have the required packages installed.

Open a bash terminal/command window and execute the following commands:

1. After you have cloned this repo, change to the root of this repo:

   console Copy

   $ cd

2. Run the env-set.sh script to initialize environment variables, and to install/use required Node & Ruby version:

   console Copy

   $ source ./tool/env-set.sh

3. Run before-install.sh to install the core set of required tools:

   console Copy

   $ ./tool/before-install.sh

4. Run install.sh to install everything else needed to build this site:

   console Copy

   $ ./tool/install.sh

IMPORTANT:

• Any time you create a new terminal/command window to work on
  this repo, repeat steps 1 and 2 above.

Developing and serving changes Copy Chapter

1. After you clone this repo, create a branch. For example:

   console Copy

   $ git checkout -b

2. Make your changes, then commit them to the branch.

3. Test your changes by serving the site locally.
   To serve locally, run either one of these commands:

   • console Copy

     $ ./tool/serve.sh # or npm run start

   OR

   • console Copy

     $ bundle exec jekyll serve --incremental --watch --livereload --port 4002

     NOTE: Unless you're editing files under site-shared, you can safely
     ignore ERROR: directory is already being watched messages.
     For details, see #1363.

     NOTE: The first time you run either one of these commands,
     Jekyll takes anywhere between 10-20 seconds to generate static
     content inside the _sites directory. If you try to verify the
     site locally, but aren't able to see the content right away,
     wait 20 seconds before stopping the
     server or concluding that something is wrong.

4. Before submitting, validate site links:

   console Copy

   $ ./tool/shared/check-links.sh

TIP: Sometimes Jekyll gets confused and seems to be out-of-sync. (This might
happen, for example, when you pull from master and lots of files have moved.)
To fix Jekyll, stop the serve.sh script, remove the generated site files:
hand, and then restart the serve.sh script:

console Copy

$ npm run clean

OR

console Copy

$ jekyll clean

OR

console Copy

$ rm -Rf ./_site/* ./.jekyll*

Next, restart the serve.sh script:

console Copy

$ npm run start

OR

console Copy

$ ./tool/serve.sh

Creating and/or editing DartPad example code Copy Chapter

Most of the code used to create DartPad examples is hosted on GitHub. However, this repo also contains
some .dart files responsible for DartPad example code.

DartPad example code in GitHub gists Copy Section

A typical DartPad example takes the form of an iframe, for example, within a codelab's markdown file:

This iframe depends on the following GitHub gist url:

https://gist.github.com/d7b09149ffee2f0535bb0c04d96987f5

For detailed instructions on how to use this approach to DartPad examples, see the DartPad embedding guide.

DartPad example code in this repo - `src/_packages/dartpad_picker` Copy Section

Some DartPad example code remains in .dart files in this repo, and must be compiled via src/_packages/dartpad_picker/compile.sh. For an example, consult src/_packages/dartpad_picker/web/dartpad_picker_main.dart.

In order to create or change example code using dartpad_picker, you must regenerate the JavaScript:

$ cd src/_packages/dartpad_picker
  $ ./compile.sh

Deploy to a staging site Copy Chapter

You can deploy your local edits to a personal staging site as follows.

1. Serve your changes locally, as previously instructed.
   Keep the serve.sh script running in its own bash shell.

2. In the Firebase Console,
   create your own Firebase project (e.g. my-foo). You only need
   to do this step once.

3. In a separate bash shell, change to the repo directory and
   initialize Firebase:

   console Copy

   $ npx firebase init

4. Tell Firebase about your project with the
   firebase use command
   You only need to do this step once:

   console Copy

   $ npx firebase use --add
   ? Which project do you want to add? <select the project you created>
   ? What alias do you want to use for this project? (e.g. staging) my-foo

5. Tell Firebase that you want to deploy to staging:

   console Copy

   $ npx firebase use my-foo
   Now using alias staging (my-foo)

6. Tell Firebase to execute deployment of your project:

$ npx firebase deploy

Your personal version of the Flutter website is now deployed to Firebase.
Copy the serving URL from the command output.

Alternate deployment script Copy Section

Alternatively, you can skip the previous steps and just use the deploy script:

$ ./tool/shared/deploy.sh --local my-foo

=== Deploying to '<your project name>'...

i  deploying hosting
i  hosting: preparing _site directory for upload...
✔  hosting: 213 files uploaded successfully
i  starting release process (may take several minutes)...

✔  Deploy complete!

Deploying to the official site Copy Chapter

As of Feb 23, 2021, official site deploys are
performed by GitHub Actions.
In the event that you need to manually deploy,
use the deploy script and the default project:

$ ./tool/shared/deploy.sh --local --robots ok default

Writing for flutter.dev Copy Chapter

The site-shared repo
contains infrastructure shared by most of our Dart and Flutter websites.
Some of this README is in the
doc
directory in the site-shared repo.

For more information on using and writing for this repo,
refer to the following docs:

• Infrastructure
• Markdown
• Examples
• Code excerpts

Also check out the site-shared
wiki:

• Images
• Mobile friendly pages: tips & tricks
• Writing for Dart and Flutter websites