Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 1 addition & 113 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,120 +4,8 @@ An express-like web server framework for Dart developers.

## Usage

A simple usage example:

```dart
import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.get('/', (req, res) {
res.json({
'hello': 'world',
'test': true,
});
});

app.listen(3000, (port) => print('Listening on port $port');
}
```

Example with route parameters

```dart
import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.get('/users/:userId/posts/:postId', (req, res) {
res.json({
'userId': req.params['userId'],
'postId': req.params['postId'],
});
});

app.listen(3000, (port) => print('Listening on port $port');
}
```

With Body parsing Middleware:

```dart
import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.use(BodyParser.json());

app.post('/post', (req, res) {
print(req.body);

res.send({
'request_body': req.body,
});
});

app.listen(3000, (port) => print('Listening on port $port');
}
```

Using the mustache templating engine

```dart
import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.use(BodyParser.json());
app.engine(MustacheEngine.use());

app.settings
..viewsPath = 'custom_views_path'
..viewEngine = 'mustache';

app.get('/', (req, res) {
res.render('index', {
'app_name': 'My Test App',
});
});

app.listen(3000, (port) => print('Listening on port $port');
}
```



Listening to Https requests

```dart
//listen for http requests
app.listen(port: 80, cb: (port) => print('listening for http on port $port'));

//assign certificate
var context = SecurityContext();
final chain = Platform.script.resolve('certificates/chain.pem').toFilePath();
final key = Platform.script.resolve('certificates/key.pem').toFilePath();

context.useCertificateChain(chain);
context.usePrivateKey(key);

//listen for https requests
app.listenHttps(
context,
port: 443,
cb: (port) => print('Listening for https on port $port'),
);
```


Check out the examples on [Github](https://github.com/deriegle/dart-express/tree/main/example).

### Currently supported View Engines

- Basic HTML
- Mustache
- Markdown
- Jael
82 changes: 0 additions & 82 deletions example/api_routes.dart

This file was deleted.

18 changes: 18 additions & 0 deletions example/body_parser.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.use(BodyParser.json());

app.post('/post', (req, res) {
res.send({
'body': req.body,
});
});

app.listen(
port: 3000,
cb: (port) => print('Listening on port $port'),
);
}
26 changes: 0 additions & 26 deletions example/dart_express_example.dart

This file was deleted.

32 changes: 32 additions & 0 deletions example/https_requests.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import 'dart:io';

import 'package:dart_express/dart_express.dart';

main() {
final app = express();

app.get('/', (req, res) {
res.json({
'hello': 'world',
'test': true,
});
});

final chain = Platform.script.resolve('certificates/chain.pem').toFilePath();
final key = Platform.script.resolve('certificates/key.pem').toFilePath();
final context = SecurityContext()
..useCertificateChain(chain)
..usePrivateKey(key);

app.listen(
port: 80,
cb: (port) => print('listening for http on port $port'),
);

//listen for https requests
app.listenHttps(
context,
port: 443,
cb: (port) => print('Listening for https on port $port'),
);
}
Loading