| ~~ Licensed to the Apache Software Foundation (ASF) under one or more |
| ~~ contributor license agreements. See the NOTICE file distributed with |
| ~~ this work for additional information regarding copyright ownership. |
| ~~ The ASF licenses this file to You 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. |
| |
| ------ |
| Building |
| ------ |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| Checking out the source |
| |
| To check out the sources, you need to run the following command |
| |
| +----------------------------------------------+ |
| $ svn checkout http://svn.apache.org/repos/asf/myfaces/html5/trunk myfaces-html5-project |
| +----------------------------------------------+ |
| |
| The project consists of 2 submodules |
| |
| * myfaces-html5-core : The component library |
| |
| * myfaces-html5-demo : The component showcase application |
| |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| Building The Project |
| |
| To build the project, you need to run the command below in the project main folder: |
| |
| +----------------------------------------------+ |
| mvn install |
| +----------------------------------------------+ |
| |
| Since the dependencies are downloaded by Maven, building the whole project (core and showcase) will take around 3 minutes |
| for the first time, (if the dependencies are not installed previously on your machine) depending on your internet connection. |
| |
| |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| Running Showcase Application |
| |
| You need to go to myfaces-html5-demo folder and run a jetty:run to run the showcase application: |
| |
| +----------------------------------------------+ |
| cd myfaces-html5-demo |
| mvn jetty:run |
| +----------------------------------------------+ |
| |
| The showcase application will be running at <http://localhost:8080/myfaces-html5-demo/index.jsf> |
| |
| Again, since the dependencies are downloaded by Maven, running the showcase application will take about 2 minutes for the first time. |
| |
| |
| |
| |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| Generating Project Site |
| |
| In the project main folder, run the command |
| |
| +----------------------------------------------+ |
| mvn -Pgenerate-site site |
| +----------------------------------------------+ |
| |
| to generate the project site. The index of the generated site will be under < PROJECT_FOLDER >/target/site/index.html |
| |
| For the first time, it may take up to 1 minute to generate the project site. |