This repository is no longer being maintained and is replaced by https://github.com/gotranseo/template.
A starting point for all of my Vapor projects
You are welcome to use this for your projects as well. It is already setup for MySQL and Redis use, and comes with User and Token classes preinstalled. You can modify it to how you see fit, but I've found that this setup works really well for me.
The template comes with the following features:
- Implementation of the
Authclass, for both the frontend and an API component - Usage of
Bearerfor authentication based off of theTokenclass - Redis to manage the caching of session tokens
- Node's Flash library
- Views and routes split up into controllers
- Full API Testing
- Custom middleware
Please follow the Vapor instructions for setting up Redis. You need to have the local server running for the app to even start
You can deploy this template to Heroku really easily (either use the CLI or the online GUI). It's already setup to work with JawsDB MySQL. You'll need to hardcode your Redis keys into the production file, at this time.
To clone this template to a new Vapor project, do this: vapor new MyProject --template=mcdappdev/vapor-template This is a little wordy and annoying to type out, so I added the following function to my .zshrc file:
nv () {
vapor new $1 --template=https://github.com/mcdappdev/Vapor-Template
}So now I just call nv HelloWorld, and it creates it using the template. Before running this template in development mode, you need to add a secrets folder to the Config directory that has a mysql.json file and a redis.json file.
Please note that using this template is exponentially easier and faster if you use Vaporize. See below.
Check out https://github.com/mcdappdev/vaporize to automate the creation of this template.
The API docs are hosted here: https://github.com/mcdappdev/slate and can be viewed at: https://mcdappdev.github.io/slate/