swift-api/swift-starter

Easy starter project for Swift

Maintainers

Details

github.com/SwiftAPI/swift-starter

Homepage

Source

Issues

Installs: 9

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v0.2.18 2024-05-07 21:32 UTC

Requires

MIT f2d1e27e49898038df18ae9ae69bc749be3ab692

frameworksymfonyphprestapiswiftSimplerest-apigraphqlcli-appphp8graphql-apigraphql-server

This package is auto-updated.

Last update: 2024-11-07 22:26:56 UTC

README

CodeFactor Version Latest Unstable Version PHP Version Require

Getting started

Install

https://packagist.org/packages/swift-api/swift-starter

composer create-project swift-api/swift-starter project_name

Init database

Make sure to fill out login detail to a database in /etc/config/database.yaml

connection:
    driver: mysqli
    host: localhost
    username: root
    password: ''
    database: myapp_db
    port: 3306
    prefix: prefix_

Init the database by running

php bin/console database:entities:update

Setup app details

Fill out /etc/config/app.yaml. Make sure to add the right baseurl, otherwise routing won't work.

All set!

Visit your site site app-domain/hello-world and you should get the following response

{
    "message": "Hey legend! Let's get started at https://henrivantsant.github.io/swift-docs/"
}

From here you can rename the references from MyApp to your own namespace and get going.

  1. Rename in root services.yaml (this references to destination to the first part of the namespace)
  2. Rename in App folder
  3. Rename in app/config.yaml
  4. Rename namespace of the HelloWorld controller or remove it