Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaronoff97/listmkr_backend
This is the backend for my PennApps XV project
https://github.com/jaronoff97/listmkr_backend
Last synced: 8 days ago
JSON representation
This is the backend for my PennApps XV project
- Host: GitHub
- URL: https://github.com/jaronoff97/listmkr_backend
- Owner: jaronoff97
- License: mit
- Created: 2017-01-21T07:19:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-22T02:34:52.000Z (almost 8 years ago)
- Last Synced: 2024-10-28T15:48:36.184Z (about 2 months ago)
- Language: Swift
- Size: 60.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vapor Example
Fork this example project as a boilerplate for working with Vapor.
Check out the [live demo](http://example.qutheory.io) running on Ubuntu.
## Badges
[](https://travis-ci.org/qutheory/vapor-example)
[](http://makeapullrequest.com)
[](http://slack.qutheory.io)
## Deploy
[](https://heroku.com/deploy)
## Documentation
View [Vapor](https://github.com/qutheory/vapor) for documentation.
## Requirements
Swift 2.2 or later is required (3.0 or later for certain features).
Works on Ubuntu, Docker, Heroku, OS X
## Building
### Swift 2.2
Visit [Getting Started](https://github.com/qutheory/vapor/wiki/Setup) in the Vapor Wiki for more details about using Swift 2.2.
### Swift 3.0
Check out Kylef's [swiftenv](https://github.com/kylef/swiftenv) for ensuring you have the latest
version of Swift installed. This project contains a `.swift-version` file which will tell `swiftenv` which version of Swift to build with automatically.
If you dont want to use `swiftenv`, visit [Swift.org](http://swift.org) to learn more about installing development snapshots on your system.
### Vapor CLI
The Vapor Command Line Interface makes it easy to build and run Vapor projects. Install it [here](https://github.com/qutheory/vapor-cli)
### Compiling
If you have the Vapor CLI, use `vapor new ` to create your new application.
Then run `vapor build` and `vapor run`.
Otherwise, clone this repo and run `swift build` to compile your application, then run `.build/debug/App`.
### Xcode 7.3
Run `vapor xcode` which will create the Xcode Project and open Xcode 7.3. Make sure Xcode > Toolchains is set to `swift-DEVELOPMENT-SNAPSHOT-2016-05-09-a.xctoolchain` or later.
Make sure your Xcode project is set to run with the working directory set to the root of the project. You can do this by going to Schemes (App or VaporApp) > Edit Scheme > Run > Options > Working Directory > Use Custom Working Directory.
## Deploying
Check the [Vapor](https://github.com/qutheory/vapor) documentation for more in-depth deployment instructions.
### Upstart
To start your `Vapor` site automatically when the server is booted, add this file to your server.
`/etc/init/vapor-example.conf`
```conf
description "Vapor Example"
start on startup
exec /home//vapor-example/.build/release/App --workDir=/home//vapor-example
```
You additionally have access to the following commands for starting and stopping your server.
```shell
sudo stop vapor-example
sudo start vapor-example
```
The following script is useful for upgrading your website.
```shell
git pull
swift build --configuration release
sudo stop vapor-example
sudo start vapor-example
```
### Heroku
Use the `vapor heroku` commands in the CLI to push to Heroku.
### Docker
You can run this demo application locally in a Linux environment using Docker.
Make sure you have installed the Vapor CLI.
1. Ensure [Docker](https://www.docker.com) is installed on your local machine.
2. Start the Docker terminal
3. cd into `vapor-example`
4. Create the Dockerfile `vapor docker init`
5. Build the container `vapor docker build`
6. Run the container `vapor docker run`
7. Optionally enter the container `vapor docker enter`
5. Configure VirtualBox to [forward ports 8080 to 8080](https://www.virtualbox.org/manual/ch06.html)
6. Visit http://0.0.0.0:8080
### Nginx / Supervisor
You can also run your Vapor app through Nginx. It’s recommended you use [Supervisor](http://supervisord.org) to run the app instance to protect against crashes and ensure it’s always running.
#### Supervisor
To setup Vapor running through Supervisor, follow these steps:
`apt-get install -y supervisor`
Edit the config below to match your environment and place it in `/etc/supervisor/conf.d/your-app.conf`:
```shell
[program:your-app]
command=/path/to/app/.build/release/App serve --ip=127.0.0.1 --port=8080
directory=/path/to/app
user=www-data
stdout_logfile=/var/log/supervisor/%(program_name)-stdout.log
stderr_logfile=/var/log/supervisor/%(program_name)-stderr.log
```
Now register the app with Supervisor and start it up:
```shell
supervisorctl reread
supervisorctl add your-app
supervisorctl start your-app # `add` may have auto-started, so disregard an “already started” error here
```
#### Nginx
With the app now running via Supervisor, you can use this sample nginx config to proxy it through Nginx:
```nginx
server {
server_name your.host;
listen 80;
root /path/to/app/Public;
# Serve all public/static files via nginx and then fallback to Vapor for the rest
try_files $uri @proxy;
location @proxy {
# Make sure the port here matches the port in your Supervisor config
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_connect_timeout 3s;
proxy_read_timeout 10s;
}
}
```