search

angelomiguelsantos / Upwest.Bundle

Other
0 stars 0 forks source link

readme

Upwest.Bundle Umbraco package

By Upwest

Build Status

Umbraco 9 and 10 tools that streamline and automate member login processes out of the box, with social login buttons (Twitter,Facebook,Linkedin and Google), automatic translations with Azure and Google Services,automatic multilingual setup, Two factor authenticion with Twilio and AspSms sms services, services for inactive accounts, backup for deleted members, email validation, recover password functionality with email templates between others. The advanced member form builder contains a bundle of higly configurable plugins that you can use also in your content type documents either in frontend and backend.

Plugins

Advanced member form builder (license required)
Auto complete (license required)
Check box (free)
Check box list by member,user,content,database or data type (license required)
Crop and upload (license required)
Date range picker (license required)
Date time picker (free)
Decimal (free)
Dropdown list by member,user,content,database or data type (license required)
Input mask (free)
Multi date picker (free)
Radio button list by member,user,content,database or data type (license required)
Server side input validation (license required)
Slider (free)
Tags (free)
Text area (free)
Text box (free)
Time picker (free)

Features

Installation

dotnet add package Upwest.Bundle 1.0.0

Manual Instalation

-Download zip file from https://github.com/angelomiguelsantos/Upwest.Bundle/ 
-Add *.dll to your references
-Add upwest.bundle\*.* to your App_Plugins folder
-Add references to 
    1-Google.Apis.Auth 1.57.0
    2-Google.Cloud.Translation.V2 2.1.0
    3-Microsoft.AspNetCore.Authentication.Google 6.0.8
    4-Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation 6.0.10
    5-TweetinviAPI 5.0.4
    6-Twilio 5.80.0
    7-Google.Apis.Auth 1.57.0
    8-ASPSMS 0.0.2 (built under .Net framework and could show you an alert on your references,If you have any trouble please use Twilio Sms service and please open an issue here)
    9-Eziriz.reactor.stacktracedeobfuscator 2.9.0
        10-Eziriz.reactor.licensing 6.9.0

Configuration

There is a set of keys in your a appsettings.json to add your provider Keys

"Upwest": {
    "AzureTranslator": {
      "Translate": false,
      "Key": "Your Key",
      "Location": "westeurope",
      "Endpoint": "https://api.cognitive.microsofttranslator.com/",
      "TranslateFrom": "en"
    },
    "GoogleTranslator": {
      "Translate": false,
      "FileName": "Your file name"
    },
    "Upwest": {
      "Key": "Please request your key to angelo.santos@upwest.pt",
      "TranslateFrom": "en",
      "SendSms" : false //if sms is sended in dev or production mode
    },
    "Recaptcha": {
      "Key": "Your Key",
      "Url": "https://www.google.com/recaptcha/api.js",
      "Secret": "Your Secret Key",
      "SiteVerifyUrl": "https://www.google.com/recaptcha/api/siteverify"
    },
    "Facebook": {
      "Key": "Your Key",
      "SecretKey": "Your Secret Key",
      "Version": "14.0"
    },
    "Twitter": {
      "Key": "Your Key",
      "Secret": "Your Secret Key",
      "AccessToken": "You Acess token",
      "AccessTokenSecret": "You Acess token secret"
    },
    "GoogleOAuth": {
      "ClientId": "Your Key",
      "Secret": "Your Secret Key"
    },
    "Linkedin": {
      "ClientId": "Your client Id",
      "ClientSecret": "Your client Secret"
    },
    "Twilio": {
      "AccountSid": "Your Account sid",
      "AuthToken": "Your Auth token",
      "PhoneNumber": "Your Phone number",
      "Activate": false
    },
    "AspSms": {
      "UserKey": "Your User Key",
      "Password": "Your Password",
      "PhoneNumber": "Your Phone number",
      "Activate": false
    }
  }

Dont´t forget to add your email settings as well.

the package will automatically add this snippet to your default template 

@*Your upwest.Member*@
@(await Component.InvokeAsync("upwest.member", new { alias = "youralias", model = Model }))
@*Your upwest.Member*@

For changing the css please add it before the snippet like this

<link rel="stylesheet" href="https://github.com/angelomiguelsantos/Upwest.Bundle/blob/main/path/to/your/styles.css">**

@*Your upwest.Member*@
@(await Component.InvokeAsync("upwest.member", new { alias = "youralias", model = Model }))
@*Your upwest.Member*@

**NOTE : ALL THE PACKAGES INCLUDED IN UPWEST.BUNDLE WERE BUILT WITH MAXIMUM CSS ISOLATION BUT CAN COLIDE WITH YOUR OWN CSS´S

IT IS NOT UPWEST RESPONSABLILTY TO ADJUST ANY KIND OF DESIGN OR CSS APART FORM THE ONES PROVIDED

All the views of Upwest.Bundle are compiled but you can override them by placing in the path /Views/Shared/Components/** If you have a license file please request the views

This package was tested in Umbraco 9.x.x and 10.x.x so it will work on these Umbraco versions. If you have any kind of problems in any of this versions please open an issue on https://github.com/angelomiguelsantos/Upwest.Bundle/issues.

If you have a license key please send an email directly to angelo.santos@upwest.pt and we contact you directly as soon as possible

Note that all the improvments and sugestions are welcome.

For production environments

Upwest keys (not reqired for localhost environment)
Azure keys for bing translation services (if applicable)
Google json file for translation services keys (if applicable)     
Facebook Sign in keys (if applicable) 
Twitter Sign in keys (if applicable) 
Linkedin Sign in keys (if applicable) 
Google Sign in keys (if applicable) 
Twilio Sms service keys (if applicable) 
AspSms Sms service keys (if applicable) 
Smtp email server account (if applicable)

Translating

When Upwest.Bundle is installed translates from English(en) to your domain languages automatically, if you have the translate switch to "true" in your appsettings.json parameter.

When you write your own inputs in your document or member types, please ensure that the language you use is the one in your appsettings.json file parameter "TranslateFrom:YOUR LANGUAGE CULTURE LETTERS" otherwise the service will not work

 "Upwest": {
      "Key": "Please request your key to angelo.santos@upwest.pt",
      "TranslateFrom": "en" <---------- HERE
    },

In the example above all the texts have to be inserted in your properties in english ("TranslateFrom": "en") for the service to work

Price

Purchase package for 120€ / one license per umbraco domain, contempling assistence and updates during a period of one year

Subscription Renewals

When your subscription expires, you can renew to receive another year of updates and support. If you choose not to renew, you can continue using the last product version released before your subscription expired.

License

Put your license.lic file in /App_Plugins/upwest.bundle/_upwest.base/[your license.lic file goes here]

Read license file - https://www.upwest.pt/#mu-license