serve 2.0.1

  • Readme
  • Changelog
  • Installing
  • 49

serve #

CLI to serves static files in a directory. Simpler to Python's python -m SimpleHTTPServer.

Installing #

pub global activate serve

Serve files in current directory #


This command by default serves content of current directory on port 8080 and host

Configure host and port #

Use --host (abbreviation -h) and --port (abbreviation -p) to serve on desired host and port.

serve -h localhost -p 8081

Serve content of specific directory #

Use --dir (abbreviated as -d) to serve contents of a desired directory.

serve -d /home/myname/mysite

Serve at a given base path #

Use --base-path (abbreviated as -b) to serve contents with desired base path.

serve -b /myblog

More features to come! #

Changelog #

1.0.3 #

  • Respects index.html

1.0.2 #

  • HTTPS support

1.0.1 #

  • Serve

1.0.0 #

  • Args

Use this package as an executable

1. Install it

You can install the package from the command line:

$ pub global activate serve

2. Use it

The package has the following executables:

$ serve

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  serve: ^2.0.1

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:serve/serve.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Jan 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.4

Health issues and suggestions

Document public APIs. (-1 points)

8 out of 8 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/serve.dart. (-1 points)

Analysis of lib/serve.dart reported 2 hints:

line 15 col 1: The class 'Future' wasn't exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.

line 15 col 42: Use = to separate a named parameter from its default value.

Maintenance suggestions

The package description is too short. (-18 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and serve.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >2.0.0 <3.0.0
args ^1.5.1 1.5.2
jaguar ^2.4.30 2.4.36
path ^1.6.2 1.6.4
Transitive dependencies
auth_header 2.1.4
charcode 1.1.2
collection 1.14.12
convert 2.1.1
crypto 2.1.4
http_server 0.9.8+3
jaguar_common 2.1.4
jaguar_serializer 2.2.12
logging 0.11.4
meta 1.1.8
mime 0.9.6+3
path_tree 2.2.2
stack_trace 1.9.3
typed_data 1.1.6
Dev dependencies
test any