Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Fill README with controller description 😁 #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −3
Open

WIP: Fill README with controller description 😁 #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,30 @@ Vapor toolbox allows to start a new project by cloning a template

To open the project in xcode, you have to generate a project

`vapor xcode`

which basicaly calls `swift package generate-xcodeproj`
`vapor xcode` which is the same as `swift package generate-xcodeproj`

Configuring the repository to use versioned hooks

`git config --local include.path ../.gitconfig`

* **pre-commit** hook - Runs swiftlint in all the project files

### The Structure

🚧 Insert an image with architecture here 🚧

#### Controllers

The controllers should be specific to the kind of communication we want to support, for example if it is **HTTP** we should have a `HTTPController`, if it is RPC we should have a `RPCController` and so on...

The controller should be responsible to configure the routes, deal with packages, requests, responses, status codes, errors and other things related with the protocol.
Everything else that isn't related with the protocol, should be handled in the specific layer.

The controller should conform with the protocol `RouterController` and implement the method `func boot(router: Router) throws` where all the routes are configured.

It should have his own set of errors, it should never expose the other layers errors through the response.
It should conform with the protocol `Debuggable` and implement the properties `identifier` and `reason`.

On going... 🚧

# About
Expand Down