• Stars
    star
    316
  • Rank 132,587 (Top 3 %)
  • Language
    Swift
  • License
    Other
  • Created over 8 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

๐Ÿ“– Documentation markdown for all Vapor packages.

Documentation

Read the docs at docs.vapor.codes

Start with Docker

  • Prerequisite for this setup, you must have docker and docker compose installed on the system
  1. first clone the repo

  2. then run

docker compose up 
  1. then open from the browser on the port 8000 e.g.
http://127.0.1.1:8000

Contributing

If you want to add information to the docs or have found any mistakes you wish to fix, feel free to create a PR for the change.

Translating


Localised docs are incredibly useful for allowing people to learn Vapor in their native language. If you wish to contribute to the Vapor documentation by translating, follow the steps below.

You'll need Python3 to build the docs. You can download this from the Python Website or install via Homebrew. Once installed, run pip install -r requirements.txt in the root directory of this repository. This will install all the needed dependencies in order to be able to build the documentation.

Following the installation of the dependencies, check if your language you want to translate to is already included in the mkdocs.yml file. If it is not, then you can add it like this:

languages:
  # Structure
  <language iso code>:
    name: <The name of the language>
    site_name: <The translated site name>
    build: true # Whether the documentation gets build or not. You can disable this if you don't want to build your language or want to temporarily disable other languages

  # Example
  nl:
    name: Nederlands
    site_name: Vapor Documentatie
    build: true

NOTE: The language code you have to add must conform to the ISO 639-1 Standard. More information can be found here.

If there are navigation components that have to be translated, then you can add them under nav_translations in the mkdocs file. This is done by specifying a keyword defined in the nav: section of the mkdocs.yml file and then adding the translation. An example can be found below of how to add those:

nav_translations:
  # Structure
  <language code>:
    <keyword>: <translation>

  # Example
  nl:
    Welcome: Welkom
    Install: Installeren

Copy the markdown file you would like to translate and name it <original name file>.<language code>.md. For example:

- index.md <- the original english documentation
- index.nl.md <- the dutch translation of the english documentation file

You can check it out by running mkdocs serve in the terminal. Once you are satisfied with your translations, feel free to create a PR. Don't forget to turn the build flag to true for all languages!

NOTE: If a file isn't translated, it will just default to the default language file. So you don't have to translate everything all at once.

Finally, you should add the new language to the issue template to ensure that any future changes are applied to the new translation and to the search index script to ensure search works correctly.

More Repositories

1

vapor

๐Ÿ’ง A server-side Swift HTTP web framework.
Swift
24,188
star
2

fluent

Vapor ORM (queries, models, and relations) for NoSQL and SQL databases
Swift
1,308
star
3

redis

Vapor provider for RediStack
Swift
458
star
4

console-kit

๐Ÿ’ป APIs for creating interactive CLI tools.
Swift
456
star
5

leaf

๐Ÿƒ An expressive, performant, and extensible templating language built for Swift.
Swift
432
star
6

postgres-nio

๐Ÿ˜ Non-blocking, event-driven Swift client for PostgreSQL.
Swift
325
star
7

jwt

Vapor JWT provider
Swift
317
star
8

toolbox

Simplifies common command line tasks when using Vapor
Swift
283
star
9

websocket-kit

WebSocket client library built on SwiftNIO
Swift
272
star
10

sql-kit

*๏ธโƒฃ Build SQL queries in Swift. Extensible, protocol-based design that supports DQL, DML, and DDL.
Swift
239
star
11

http

๐Ÿš€ Non-blocking, event-driven HTTP built on Swift NIO.
Swift
238
star
12

mysql-kit

๐Ÿฌ Pure Swift MySQL client built on non-blocking, event-driven sockets.
Swift
222
star
13

fluent-kit

Swift ORM (queries, models, and relations) for NoSQL and SQL databases
Swift
206
star
14

postgres-kit

๐Ÿ˜ Non-blocking, event-driven Swift client for PostgreSQL.
Swift
187
star
15

jwt-kit

๐Ÿ”‘ JSON Web Token (JWT) signing and verification (HMAC, ECDSA, EdDSA, RSA, PSS) with support for JWS and JWK
Swift
180
star
16

queues

A queue system for Vapor.
Swift
163
star
17

fluent-postgres-driver

๐Ÿ˜ PostgreSQL driver for Fluent.
Swift
145
star
18

api-template

๐Ÿ’ง A starting point for Vapor APIs.
Swift
135
star
19

open-crypto

๐Ÿ”‘ Hashing (BCrypt, SHA2, HMAC), encryption (AES), public-key (RSA), and random data generation.
Swift
134
star
20

multipart-kit

๐Ÿž Parses and serializes multipart-encoded data with Codable support.
Swift
132
star
21

routing-kit

๐Ÿš High-performance trie-node router.
Swift
122
star
22

apns

Helpful extensions and abstractions for using APNSwift
Swift
115
star
23

mysql-nio

๐Ÿฌ Non-blocking, event-driven Swift client for MySQL.
Swift
88
star
24

service

๐Ÿ“ฆ Dependency injection / inversion of control framework.
Swift
85
star
25

core

๐ŸŒŽ Utility package containing tools for byte manipulation, Codable, OS APIs, and debugging.
Swift
80
star
26

fluent-mysql-driver

๐Ÿ–‹๐Ÿฌ Swift ORM (queries, models, relations, etc) built on MySQL.
Swift
76
star
27

async-kit

Sugary extensions for the SwiftNIO library
Swift
71
star
28

template

Used by Vapor Toolboxโ€™s new project command
Swift
70
star
29

fluent-sqlite-driver

Fluent driver for SQLite
Swift
67
star
30

sqlite-kit

Non-blocking SQLite client library with SQL builder built on SwiftNIO
Swift
58
star
31

sqlite-nio

Non-blocking wrapper for libsqlite3-dev using SwiftNIO
C
58
star
32

validation

โœ… Extensible data validation library (name, email, etc)
Swift
56
star
33

auth

๐Ÿ‘ค Authentication and Authorization framework for Fluent.
Swift
53
star
34

leaf-kit

๐Ÿƒ An expressive, performant, and extensible templating language built for Swift.
Swift
47
star
35

template-kit

๐Ÿ“„ Easy-to-use foundation for building powerful templating languages in Swift.
Swift
45
star
36

website

Vapor's website running on Swift
Swift
45
star
37

docs-cn

๐Ÿ‡จ๐Ÿ‡ณ Chinese translation of Vapor's documentation markdown.
HTML
43
star
38

web-template

A starting point for web applications
Swift
41
star
39

url-encoded-form

๐Ÿ“ Parse and serialize url-encoded form data with Codable support.
Swift
41
star
40

database-kit

๐Ÿ—„ Core services for creating database integrations.
Swift
40
star
41

auth-template

A starting point for Vapor applications using the auth provider.
Swift
35
star
42

university

Web application, iOS app, and API providing access to tutorials for the Vapor web framework.
Swift
24
star
43

fluent-mongo-driver

MongoDB support for Fluent built on MongoKittten.
Swift
24
star
44

queues-redis-driver

A Redis implementation for https://github.com/vapor/queues
Swift
22
star
45

design

Contains the reference designs and build pipeline to generate all design files for Vapor's sites
Swift
22
star
46

email

A common API for Vapor to integrate with different email providers
Swift
20
star
47

codable-kit

Conveniences for working with Swift's Codable protocols.
Swift
19
star
48

kafka

Swift Apacha Kafka (real-time data pipelines and streaming apps)
Swift
19
star
49

apt

Manage Vapor's Swift APT repository
Shell
17
star
50

blog

The Vapor Blog
Swift
16
star
51

penny-bot

The code that runs Penny ๐Ÿค–
Swift
15
star
52

template-bare

A barebones template ready for use
Swift
12
star
53

docker

Swift
12
star
54

api-docs

Scripts and assets for Vapor's API documentation site at https://api.vapor.codes
Swift
11
star
55

redis-kit

Helpful extensions and abstractions for using RediStack
Swift
8
star
56

swift-getting-started-web-server

The source code for the Getting Started Guide on Vapor on swift.org
Swift
7
star
57

homebrew-tap

Homebrew Taps
Ruby
7
star
58

template-fluent-postgres

A template ready for use configured with Fluent and PostgreSQL
Swift
6
star
59

release-bot

Webhook-based GitHub bot that automatically tags new releases and posts to Discord when you merge PRs
Swift
6
star
60

ci

Support files and configurations for Vapor's CI
Swift
5
star
61

bot-github

A github bot to do things like interact with CI for the Vapor organization
Swift
5
star
62

template-fluent-postgres-leaf

A template ready for use configured with Leaf, Fluent and PostgreSQL
Swift
4
star
63

swiftly-action

Simple one-step access to the Swiftly toolchain manager from GitHub Actions workflows
3
star
64

swift-codecov-action

A GitHub Action which performs Codecov.io uploads with additional support for Swift projects
Swift
3
star
65

template-fluent-mysql

A template ready for use configured with Fluent and MySQL
Swift
2
star
66

docs-de

Deutsche รœbersetzung der Vapor-Dokumentation
HTML
1
star