Permalink
Browse files

Merge branch 'master' of github.com:socialsignin/mvn-archetype-social…

…signin-webapp
  • Loading branch information...
2 parents 8112d30 + 4377dc9 commit accc3cac55f417c2c147cf0f8c083568fdd64bb4 @michaellavelle michaellavelle committed Jan 1, 2012
Showing with 46 additions and 0 deletions.
  1. +46 −0 README
View
46 README
@@ -0,0 +1,46 @@
+This archetype generates a SocialSignIn webapp, which provides out of the box support for
+
+1) spring-social modules (Allows connection to 3 party provider APIs)
+
+2) spring-social-security ( Removes need for local user account management, delegating to 3rd party for login details - no
+local usernames or passwords are needed. )
+
+3) socialsignin-modules ( Easy configuration of spring social providers using component scanning )
+
+
+To use this archetype use the mvn archetype:generate plugin:
+
+mvn archetype:generate \
+-DarchetypeRepository=https://github.com/OpenSourceAgility/opensourceagility-mvn-repo/raw/master/snapshots \
+-DarchetypeGroupId=org.socialsignin \
+-DarchetypeArtifactId=mvn-archetype-socialsignin-webapp \
+-DarchetypeVersion=1.0.1-SNAPSHOT \
+-DgroupId=com.mygroup \
+-DartifactId=myartifactid \
+-Dversion=1.0.0-SNAPSHOT
+
+where the groupId,artifactId and version properties are your own project values.
+
+Properties which can be specified for this archetype are the list of providers to be supported,
+the clientIds and secrets for each provider and whether to use the in memory database for quickstart.
+
+By default, support for all 6 providers will be generated (facebook,twitter,lastfm,soundcloud,mixcloud and linkedin),
+the clientIds and secrets for each one will be "not set" in the environment.properties file and the app will
+use an in-memory database for development purposes.
+
+To override these defaults (ie. to change the list of providers supported, to set your client id and secrets for
+your app, or to switch off in-memory database, answer 'N' when asked to confirm the default properties and you
+can then enter your chosen values.
+
+
+Once you have created your new project using this archetype, you'll need to obtain client API accounts for your chosen
+providers and ensure that the client ids and secrets are set in the environment.properties file. You may also need
+to configure the return urls set on each provider account to be http://localhost:8080/ (depending on the provider).
+
+You can then start your project webapp using jetty:
+
+mvn jetty:run
+
+Go to http://localhost:8080/ to run the application
+
+

0 comments on commit accc3ca

Please sign in to comment.