Spring Template to create Ui5Strap powered Websites and / or Web Services for Ui5Strap Apps.
JavaScript Java Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
biz.bleta.cloud.tools.notes
de.pksoftware.springstrap.basic
de.pksoftware.springstrap.cms
de.pksoftware.springstrap.core
.classpath
.gitignore
LICENSE
README.md

README.md

PRE ALPHA

Please do not use Springstrap for production yet.

Springstrap

Spring Template to create Ui5Strap powered Websites and / or Web Services for Ui5Strap Apps.

@author Jan Philipp Knöller

Homepage: http://ui5strap.com/springstrap

Copyright (c) 2013-2016 PKSoftware - Jan Philipp Knöller

Installation

  1. Clone the springstrap repository into your workspace folder. You should get a new directory "springstrap", which is your local copy of the latest springstrap version. Do not modify files inside this folder.

  2. Create a new empty directory (such as "myproject") inside your workspace folder. It should be a sibling of the "springstrap" folder.

  3. Copy "tld.mydomain.example" from the "springstrap" folder into your new directory ("myproject").

  4. Rename the folder "tld.mydomain.example" inside your new directory according to your company and project name (such as "com.mycompany.myproject"). Please use Java package naming convention here.

  5. Open "com.mycompany.myproject/pom.xml" and change the groupId from "tld.mydomain" to "com.mycompany". Change the artifactId from "tld.mydomain.example" to "com.mycompany.myproject".

Run in Terminal

Make sure maven is installed on your system.

  1. Open the terminal and change into "myproject/com.mycompany.myproject".

  2. Run "mvn clean tomcat7:run" to start the server.

  3. Now you can open http://localhost:7373 in your browser.

Eclipse Import

It's recommended to use Eclipse for Java EE developers.

  1. Open Eclipse and switch to your workspace folder.

  2. Rightclick the Project Explorer and choose "Import...". Select "Maven/Existing Maven Projects" in the window.

  3. Click on "Browse..." and select your newly created folder from Installation step 2 ("myproject").

  4. Check the Project from the list and click "Finish". Your project "com.mycompany.myproject" should now appear in your Project Explorer.

  5. Righclick your new project and choose "Run As" -> "Maven build...".

  6. Enter "clean tomcat7:run" in "Goals" and click "Run".

  7. Now you can open http://localhost:7373 in your browser.

Next Steps

It's strongly recommended to rename packages and configuration classes before starting development. To rename the packages and classes, rightlick them in the Project Explorer in Eclipse and choose "Refactor" -> "Rename...".

  • Rename the packages "tld.mydomain.example.*" to "com.mycompany.myproject.*".
  • Rename the Configuration Files inside com.mycompany.myproject.config from "Example*Config.java" to "MyProject*Config.java". Make sure you only replace prefix "Example" and that you keep the rest of the names.

License

The Springstrap library is licensed under the Apache License 2.0; the example application is licensed under the MIT License.

##Springstrap Library

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Released under Apache2 license: http://www.apache.org/licenses/LICENSE-2.0.txt

##Example Application

Licensed under the MIT License (MIT)

Copyright (c) 2016 PKSoftware - Jan Philipp Knöller

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.