ml-archive / readme Goto Github PK

View Code? Open in Web Editor NEW

56.0 11.0 88.0 287 KB

Welcome to Vapor development at Nodes 📖

swift vapor server-side-swift stso documentation

readme's Introduction

Vapor at Nodes

Welcome to the Vapor team at Nodes' space on GitHub. We ❤️ Vapor. Look below to see what we are working on.

Feel free to get in touch or to submit a PR to any of our repos.

Documentation

Creating a project
- How to start a project
- How to build a package
Syntax, semantics and structure
- How to write Swift
- How to write APIs
Releasing
- How to release a version
- Checklist before going live with a project
Database
- How to create an entity relationship diagram
- How to support emojis (utf8mb4)
Hosting
- How to setup environment variables
- How to deploy and host Vapor apps
Third party integrations
- Push notifications with Urban Airship
- How to report errors to Bugsnag
Postman
Misc

Configuration

Git ignore
CircleCI (please note the folder structure)
Travis
Codecov
SwiftLint
Codebeat

Blogging

Our blog
Ideas for future posts (please see the readme for more information)

Packages

Made at Nodes

Admin Panel ✍️ (note: the old one can be found here)
Admin Panel Nodes SSO 🔑
JWT Keychain ⛓
Template 🏎 (note: our old Vapor 1 template can be found here)
Storage 🗄
Sourcery Templates ✨
Sanitized
Meta
Audit 🕵️
Bugsnag 🐛
Slugify
AWS
Sugar 🍬
Stacked 📚
Paginator 📄
NStack
UAPusher ✉️
Error Extended
Gatekeeper 👮
DataURI
Flash ⚡️
Dockerfiles 🐳

Made by others

readme's People

Contributors

Stargazers

Watchers

Forkers

kimdv danielsmedegaardbuus dmead28 pontarou ditansu johsoe jdmcd pritesh-volansys notestyle cutedogspark dharmeshahuja stfares haneendev klaudiastewart vikas-mindpath fabiomendesvieira paola-xaq evacalla brunomoreno7538 shuvya jasonakon mauretee marreche cassiorp satvik2204 merouanebellaha xnubber vandistel johnconnor77 jayash-goglocal lanodburke amamov sahil-ra ezokovich boybubbles tchiayan jfusterprove creatorghost elmango1508 rabbitterra huyqduong adham-source johnm28 radxhunter yusupovjaloliddin print-varunsharma kacper-sleziak nancyhossamalnamer william-io wdmahbubur ayoubbasidi miguelaledesma ahmed-cheibani proximaparada muke5hy kananbunyadovv sergeyselya pavithrakanag filipperodrigues bakecog w-bouzazi sabirlkhaloufi lord-lava niaz-estefaie mardoqueu vitali-kaleidoo mleng-ms-ubr jenniferhalloran mrraccxxn mhdginola lily-vu-goldenowl clawedcatalyst nerdxio xavimg humphrey-nyaga nlvpatrick kurkulya nguyentung59 wahaj-yousef tannguyen1295 erolislen nguyendanny010 sngom1995 oaayoub rishunayak mansi-edrv dexxp

readme's Issues

Publish files from package to project

Add more MySQL types to Schema.Creator

extension Schema.Creator {
    public func datetime(
        _ name: String,
        optional: Bool = false,
        unique: Bool = false,
        default: NodeRepresentable? = nil
    ) {
        custom(name, type: "DATETIME", optional: optional, unique: unique, default: default)
    }
}

but we need some of the other things like
forgot pw

old package
https://github.com/nodes-php/api-scaffolding

We can either create a package with a command which scaffolds this, like our old package

or we can create a start project we clone when starting a new project?

Flash session system

Started this briefly in sandbox project Admin source

We need something like laravel has
Flash messages: https://github.com/laracasts/flash
Validation errors: redirect back with errors and input

SwiftDate does not compile for Linux

So I just figured out when trying to deploy

I created some fast extensions here

import Foundation

extension Date {
    
    public enum Error: Swift.Error {
        case couldNotParse
    }
    
    public static func parse(_ format: String, _ date: String) -> Date {
        let dateFormatter = DateFormatter()
        dateFormatter.dateFormat = format
        
        return dateFormatter.date(from: date) ?? Date()
    }
    
    public static func parse(_ date: String) -> Date {
        return Date.parse("yyyy-MM-dd HH:mm:ss", date)
    }
    
    public static func parseOrThrow(_ format: String, _ date: String?) throws -> Date {
        guard let dateString: String = date else {
            throw Error.couldNotParse
        }
        
        let dateFormatter = DateFormatter()
        dateFormatter.dateFormat = format
        
        let newDate = dateFormatter.date(from: dateString)
        
        guard let newDateUnw = newDate else {
            throw Error.couldNotParse
        }
        
        return newDateUnw
    }
   
    public static func parseOrThrow(_ date: String?) throws -> Date {
        return try Date.parseOrThrow("yyyy-MM-dd HH:mm:ss", date)
    }
    
    public func to(_ format: String) throws -> String {
        let dateFormatter = DateFormatter()
        dateFormatter.dateFormat = format
        
        return dateFormatter.string(from: self)
    }
    
    public func toDateTimeString() throws -> String {
        return try self.to("yyyy-MM-dd HH:mm:ss")
    }
    
    public func isPast() -> Bool {
        return self.compare(Date()).rawValue < 0
    }
    
    public func isFuture() -> Bool {
        return self.compare(Date()).rawValue > 0
    }
}

Is this something we should have one time? else our code will be super ugly :)

@steffendsommer @rasmusebbesen @NickSkull @skyback @BrettRToomey

How to enable UTF8MB4 support on Vapor?

Go to:

Config/

mysql.json
secrets/
- mysql.json
  And replace

"encoding": "utf8" by "encoding": "utf8mb4"

Shouldn't we make it so you only change the encoding of the fields where you need to have it?

@skyback @rasmusebbesen ?

Package: Browsecap

https://browscap.org/ or like it

important thing Is you dont have to compare user agents. that we have a system for it

Can be api, nstack or a microservice. I dont care

Admin panel

Something simular to: https://github.com/nodes-php/backend

Ideas: build it as a package everyone else can use, make a nodes version of the same package, which just extends the things we need different

Sugar: Make softdelete optional

See ml-archive/sugar#8

Admin panel: NStack integration

See ml-archive/admin-panel#3

Bugsnag: Release stage filtering

See ml-archive/bugsnag#2

Multiple auths in same drop

We need to run a auth for api and one for backend.

Timestamps created_at and updated_at as Datetime

Admin panel: update validations

See ml-archive/admin-panel#30

Mailgun api client https://github.com/vapor/vapor/issues/781

A way to force SSL requests

Maybe there is a way, else it's easy to do that middleware

Admin panel: automatic application name

See ml-archive/admin-panel#38

MySQL Transactions support

Missing transactions
Transactions are an important part of complex database interactions.

http://dev.mysql.com/doc/refman/5.7/en/commit.html

Test helper package

We should have a package that gives you all related helpers/mocks/stubs when testing Vapor projects.

Missing reference in deployment section

Would be nice to have the guide on how to set up vapor cloud linked.

Lacking data source documentation
I am missing a section in the official docs regarding data sources. Persisting data is an integral part of most web based systems and there should be a dedicated section for this to make vapor more accessible to newcomers.
Also docs regarding column attributes in my data source. Nullable fields, unsigned integers etc.
Missing docblocks in the source
One of the best things about Laravel is that most of the code base is fully documented with doc blocks. They even have design guides to how doc blocks should look. Some parts of the code base is missing this (though I have also encountered several helpful ones)
Basic database operations
Database operations are not documented with clear examples. Common operations such as UPDATE and DELETE are not present in the docs. Only a very simple CREATE along with some generic JOIN example could be found.

Request: How to set up dev environment

Following the guides at Vapor (which also are out of date) does not seem to be enough - as there are Nodes specifics as well (mysql, mongodb, more?) - a guide would be much appreciated instead of blocking two developers for x amount of time.

Thanks in advance :)

Support for having views in a package

JWTKeychain: Make it more flexible

We need to figure out how we can make the JWTKeychain package flexible so that on one hand we get a lot for free out-of-the-box when rolling out simple projects, but on the other hand we are to extend/modify to our needs when dealing with more custom requirements.

See

Change guideline for versioning API to use URL

@cweinberger As you suggested, we should use the URL for versioning APIs. This also matches other internal documents we have.

Request throttle limit middleware

Fluent, better limit func

Primary id is a INT not not SIGNED

MySQL Primary keys
The id() preparation function generates a signed int field as my table’s primary key. It should not be signed.

Mysql Query with NULL is not supported

Querying database for NULL values...
...seems impossible with Vapor. Need to use raw querying to achieve this. A query comparison filter .isNull could be an elegant solution (as well as an .isNotNull filter)

Should we formalize JSend for API responses?

Looking into our API guidelines and wondering why we should return 200 + {"status": "ok"} when there is no data (eg. for DELETE) instead of using 204 with an empty body I found this (JSend).
The guidelines mostly already follow this (except for "ok" instead of "success"). It does not seem to be an official spec but "success" pops up everywhere I find it mentioned.

I see 3 options:

change nothing
mention JSend
mention JSend and change "ok" to "success"

What do you think?

@steffendsommer

import Vapor
import Fluent
import Foundation
import HTTP
import Turnstile
import TurnstileCrypto
import SwiftDate
import Auth

public final class BackendUser: Auth.User, Model {
    
    public var exists: Bool = false
    public static var entity = "backend_users"
    
    public var id: Node?
    public var name: String
    public var email: Valid<Email>
    public var password: String
    public var role: String
    public var createdAt: DateInRegion
    public var updatedAt: DateInRegion
    
    enum Error: Swift.Error {
        case userNotFound
        case registerNotSupported
        case unsupportedCredentials
    }
    
    public init(node: Node, in context: Context) throws {
        id = try node.extract("id")
        name = try node.extract("name")
        let emailTemp: String = try node.extract("email")
        email = try emailTemp.validated()
        password = try node.extract("password")
        role = try node.extract("role")
        
        do {
            createdAt = try DateInRegion(string: node.extract("created_at"), format: .custom("yyyy-MM-dd HH:mm:ss"))
        } catch {
            createdAt = DateInRegion()
        }
        
        do {
            updatedAt = try DateInRegion(string: node.extract("updated_at"), format: .custom("yyyy-MM-dd HH:mm:ss"))
        } catch {
            updatedAt = DateInRegion()
        }
    }