This repository has been archived by the owner on Apr 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from nodes-vapor/feature/prepare-first-release
WIP: Finalize first release
- Loading branch information
Showing
71 changed files
with
796 additions
and
5,216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| os: | ||
| - osx | ||
|
|
||
| language: swift | ||
| sudo: required | ||
| osx_image: xcode8.3 | ||
|
|
||
| before_install: | ||
| brew tap vapor/tap; | ||
| brew update; | ||
| brew install vapor; | ||
| brew install cmysql; | ||
| gem install xcpretty; | ||
|
|
||
| script: | ||
| - swift build | ||
| - swift build -c release | ||
| - swift package generate-xcodeproj --enable-code-coverage | ||
| - xcodebuild -scheme AdminPanelProvider -enableCodeCoverage YES test | xcpretty && exit ${PIPESTATUS[0]} | ||
|
|
||
| after_success: | ||
| - bash <(curl -s https://codecov.io/bash) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| var AdminPanel = (function() { | ||
| return { | ||
| confirmDelete: function(element) { | ||
| // Confirm modal title | ||
| var modalTitle = $(element).data('header'); | ||
| modalTitle = !modalTitle ? 'Please confirm' : modalTitle; | ||
|
|
||
| // Confirm modal text | ||
| var modalText = $(element).data('text'); | ||
| modalText = !modalText ? 'Are you sure you want to delete?' : modalText; | ||
|
|
||
| var closure = function(e) { | ||
| // Prevent default action | ||
| e.preventDefault(); | ||
|
|
||
| // Generate bootbox dialog | ||
| bootbox.dialog({ | ||
| title: modalTitle, | ||
| message: '<span class="fa fa-warning"></span> ' + modalText, | ||
| className: 'modal modal-danger', | ||
| buttons: { | ||
| cancel: { | ||
| label: 'Cancel', | ||
| className: 'btn-outline' | ||
| }, | ||
| success: { | ||
| label: 'Delete', | ||
| className: 'btn-outline', | ||
| callback: function () { | ||
| if ($(element).is('form')) { | ||
| $(element).trigger('submit'); | ||
| } else { | ||
| // Since we're posting data, we need to add our CSRF token | ||
| // to our form so Laravel will accept our form | ||
| // var csrfToken = $(element).data('token'); | ||
| // if (!csrfToken) { | ||
| // alert('Missing CSRF token'); | ||
| // console.log('Missing CSRF token'); | ||
| // return; | ||
| // } | ||
|
|
||
| // Since <form>'s can't send a DELETE request | ||
| // we need to use `POST` | ||
| $('<form/>', { | ||
| 'method': 'POST', | ||
| 'action': $(element).attr('href') | ||
| }).appendTo('body').submit(); | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| onEscape: true | ||
| }); | ||
| }; | ||
|
|
||
| if ($(element).is('form')) { | ||
| $(element).find(':submit').click(closure); | ||
| } else { | ||
| $(element).click(closure); | ||
| } | ||
| } | ||
| } | ||
| })(); | ||
|
|
||
| $( document ).ready(function() { | ||
| $('[data-delete="true"]').each(function() { | ||
| AdminPanel.confirmDelete($(this)); | ||
| }); | ||
| }) |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,126 @@ | ||
| # Admin Panel Provider | ||
| # Admin Panel ✍️ | ||
| [](http://swift.org) | ||
| [](http://vapor.codes) | ||
| [](https://circleci.com/gh/nodes-vapor/admin-panel-provider) | ||
| [](https://travis-ci.org/nodes-vapor/admin-panel-provider) | ||
| [](https://codebeat.co/projects/github-com-nodes-vapor-admin-panel-provider) | ||
| [](https://codecov.io/gh/nodes-vapor/admin-panel-provider) | ||
| [](http://clayallsopp.github.io/readme-score?url=https://github.com/nodes-vapor/admin-panel-provider) | ||
| [](https://raw.githubusercontent.com/nodes-vapor/admin-panel-provider/master/LICENSE) | ||
|
|
||
| Admin Panel makes it easy to setup and maintain admin features for your Vapor project. Here's a list of some of the top feautures that comes out of the box with this package: | ||
|
|
||
| - **UI Components:** Admin Panel is built using [AdminLTE](https://adminlte.io/), a highly battle-tested and maintained Control Panel Template. This means that you'll have access to features from AdminLTE through [Leaf](https://docs.vapor.codes/2.0/leaf/leaf/#leaf) tags. | ||
| - **User System:** This package come with a (admin panel) user system with roles built-in. The package also handles welcome emails and reset-password flows. | ||
| - **SSO Support:** Built-in support for adding your own custom SSO provider. | ||
| - **Activities**: Need to broadcast certain updates to the admin panel users? No problem, Admin Panel gives you some convenient functionality to manage an activity log. | ||
|
|
||
| ## 📦 Installation | ||
|
|
||
| ### Install package using SPM | ||
|
|
||
| Update your `Package.swift` file: | ||
|
|
||
| ```swift | ||
| .Package(url: "https://github.com/nodes-vapor/admin-panel-provider.git", majorVersion: 0, minorVersion: 1) | ||
| ``` | ||
|
|
||
| Next time you run e.g. `vapor update` Admin Panel will be installed. | ||
|
|
||
| ### Install resources | ||
|
|
||
| Move the `Resources`and `Public` folders from this repo into your project. Unfortunately there's no convenient to this at the moment, but one option is to download this repo as a zip and then move the folders into the root of your project. Remember to check that you're not overwriting any files in your project. | ||
|
|
||
|
|
||
| ## 🚀 Getting started | ||
|
|
||
| ### Add provider | ||
|
|
||
| In your `Config+Setup.swift` (or wherever you setup your providers), make sure to add the Admin Panel provider: | ||
|
|
||
| ```swift | ||
| import AdminPanelProvider | ||
|
|
||
| // ... | ||
|
|
||
| private func setupProviders() throws { | ||
| // ... | ||
| try addProvider(AdminPanelProvider.Provider.self) | ||
| } | ||
| ``` | ||
|
|
||
| ### Setup view renderer | ||
|
|
||
| This package relies heavily on the [Leaf](https://docs.vapor.codes/2.0/leaf/package/) view renderer. For Admin Panel to work, please make sure that you have added the `LeafProvider`: | ||
|
|
||
| ```swift | ||
| import LeafProvider | ||
|
|
||
| // ... | ||
|
|
||
| private func setupProviders() throws { | ||
| // ... | ||
| try addProvider(LeafProvider.Provider.self) | ||
| } | ||
| ``` | ||
|
|
||
| After adding the provider, please make sure that your project is using Leaf as the view renderer. To do that, please ensure that the `view` key is set correctly in `droplet.json`: | ||
|
|
||
| ```json | ||
| "//": "Choose which view renderer to use", | ||
| "//": "leaf: Vapor's Leaf renderer", | ||
| "view": "leaf" | ||
| ``` | ||
|
|
||
| ### Seed a user | ||
|
|
||
| If you haven't added a SSO provider, the next thing you need to do is to seed a user in order to be able to login into your new admin panel. To do this, first add the seeder command to your `commands` array in your `droplet.json`: | ||
|
|
||
| ```json | ||
| "//": "Choose which commands this application can run", | ||
| "//": "prepare: Supplied by the Fluent provider. Prepares the database (configure in fluent.json)", | ||
| "commands": [ | ||
| "prepare", | ||
| "admin-panel:seeder" | ||
| ], | ||
| ``` | ||
|
|
||
| Next run the seeder by doing: | ||
|
|
||
| ``` | ||
| vapor build; vapor run admin-panel:seeder | ||
| ``` | ||
|
|
||
| The user that will be created using the seeder will have the following credentials: | ||
|
|
||
| - Email: **admin@admin.com** | ||
| - Password: **admin** | ||
|
|
||
| ## 🔧 Configurations | ||
|
|
||
| Admin Panel can be configured by (adding or) modifying the `adminpanel.json` config file. Below is a breakdown of the available keys. | ||
|
|
||
| | Key | Example value | Required | Description | | ||
| | --------- | ----------------------- | -------- | ---------------------------------------- | | ||
| | `name` | `My Tech Blog` | No | This will be the title inside of the admin panel. | | ||
| | `baseUrl` | `http://mytechblog.com` | No | This will be used to generate urls for the admin panel (e.g. when resetting a password). | | ||
| | `skin` | `green-light` | No | The skin to use for the admin panel. The options will correspond to the [available skins](https://adminlte.io/themes/AdminLTE/documentation/index.html#layout) supported by AdminLTE. Please omit the `skin-` prefix when specifying the skin. | | ||
|
|
||
| ### Mailgun | ||
|
|
||
| To support sending password reset emails, configure Mailgun using `mailgun.json`. In addition to the values for `key` and `domain`, AdminPanelProvider requires a value for the key `fromAddress` and `fromName` which will be used as the sender for password reset emails. | ||
|
|
||
| ## 🔐 SSO | ||
|
|
||
| Single sign-on can be a convenient way to offer users of your project to login into your admin panel. | ||
|
|
||
|
|
||
| ## 🏆 Credits | ||
|
|
||
| This package is developed and maintained by the Vapor team at [Nodes](https://www.nodesagency.com). | ||
| The package owner for this project is [Steffen](https://github.com/steffendsommer). | ||
|
|
||
|
|
||
| ## 📄 License | ||
|
|
||
| This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) |
2 changes: 1 addition & 1 deletion
2
Resources/Views/BackendUser/edit.leaf → ...es/Views/AdminPanel/BackendUser/edit.leaf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
Resources/Views/BackendUser/index.leaf → ...s/Views/AdminPanel/BackendUser/index.leaf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| #extend("Layout/page") | ||
| #extend("AdminPanel/Layout/page") | ||
|
|
||
| #export("title") { Backend Users } | ||
|
|
||
|
|
||
2 changes: 1 addition & 1 deletion
2
Resources/Views/Dashboard/index.leaf → ...ces/Views/AdminPanel/Dashboard/index.leaf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| #extend("Layout/page") | ||
| #extend("AdminPanel/Layout/page") | ||
|
|
||
| #export("nav-top") { | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
Resources/Views/Layout/fullscreen-page.leaf → ...ws/AdminPanel/Layout/fullscreen-page.leaf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.