# Vapor Documentation

This is the documentation for Vapor, a Web Framework for Swift that works on iOS, macOS, and Ubuntu; and all of the packages that Vapor offers. 

Vapor is the most used web framework for Swift. It provides a beautifully expressive and easy to use foundation for your next website or API.

To view the framework's source code and code documentation, visit [Vapor's GitHub](https://github.com/vapor/vapor).

## How To Read

You can read this guide by clicking through the folders and markdown files on [GitHub](https://github.com/vapor/documentation) or through the rendered [GitHub Pages](https://vapor.github.io/documentation/).

## Packages

Here are a list of all the Swift 3, linux-ready packages and modules provided open source by Vapor.

- [Vapor](https://github.com/vapor/vapor): Swift's most used web framework.
	- Routing: Generic branch router.
	- HTTPRouting: HTTP router specializations.
	- Type-safe Routing: Generated route methods for type-safe parameters.
- [Fluent](https://github.com/vapor/fluent): Models, relationships, and querying for NoSQL and SQL databases.
- [Engine](https://github.com/vapor/engine): Core transport layers.
	- HTTP: Pure Swift HTTP client and server.
	- URI: Pure Swift URI parsing and serializing.
	- WebSockets: Full-duplex communication channels over a single TCP connection.
	- SMTP: Send email using Sendgrid and Gmail.
	- Transport: Streams and transfer protocols.
- [JSON](https://github.com/vapor/json): Maps Foundation JSON to Swifty enum.
- [Console](https://github.com/vapor/console): Swift wrapper for console IO and commands.
- [Node](https://github.com/vapor/node): A formatted data encapsulation meant to facilitate the object conversions.
- [TLS](https://github.com/vapor/tls): Swift OpenSSL and TLS.
- [MySQL](https://github.com/vapor/mysql): Robust MySQL interface for Swift.
	- [MySQL Driver](https://github.com/vapor/mysql-driver): MySQL driver for Fluent.
	- [MySQL Provider](https://github.com/vapor/mysql-provider): MySQL provider for Vapor.
- [SQLite](https://github.com/vapor/sqlite): SQLite 3 wrapper for Swift
	- [SQLite Driver](https://github.com/vapor/sqlite-driver): SQLite driver for Fluent.
	- [SQLite Provider](https://github.com/vapor/sqlite-provider): SQLite provider for Vapor.
- [PostgreSQL](https://github.com/vapor/postgresql): Robust PostgreSQL interface for Swift.
	- [PostgreSQL Driver](https://github.com/vapor/postgresql-driver): PostgreSQL driver for Fluent.
	- [PostgreSQL Provider](https://github.com/vapor/postgresql-provider): PostgreSQL provider for Vapor.
- [Mongo Driver](https://github.com/vapor/mongo-driver): MongoKitten driver for Fluent.
- [Polymorphic](https://github.com/vapor/polymorphic): Syntax for easily accessing values from generic data.
- [Path Indexable](https://github.com/vapor/path-indexable): A protocol for powerful subscript access of data types.
- [Core](https://github.com/vapor/core): Core extensions, type-aliases, and functions that facilitate common tasks.

> Not all packages may be up to date with the latest Swift snapshot or Vapor release. Updating packages is an easy and great way to contribute!

## Authors

[Tanner Nelson](mailto:tanner@qutheory.io), [Logan Wright](mailto:logan@qutheory.io), and the hundreds of members of Vapor.