mirror of
https://github.com/Alfresco/SearchServices.git
synced 2025-09-10 14:11:25 +00:00
Add readme detailing project layout and commands
This commit is contained in:
32
search-services/alfresco-solr/README.md
Normal file
32
search-services/alfresco-solr/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Alfresco Solr Application
|
||||
TODO Add project description.
|
||||
## How to build
|
||||
Build:
|
||||
```
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
## How to test
|
||||
```
|
||||
mvn test
|
||||
or
|
||||
mvn test -Dtest={testname}
|
||||
```
|
||||
|
||||
### Project Layout
|
||||
|
||||
```
|
||||
.
|
||||
├── /README.md # Readme file.
|
||||
├── /pom.xml # Project configuration and meta data.
|
||||
├── /src # Project source code folder.
|
||||
| ├── /main # Main application folder.
|
||||
| | ├── /java # Application code.
|
||||
| | ├── /resources # Main application resource.
|
||||
| | | ├── /solr # solr resource.
|
||||
| | ├── /webapp # Web application code.
|
||||
| ├── /test/ # Test folder.
|
||||
| | ├── /java # Java test class folder.
|
||||
| | ├── /resources # Test resource directory.
|
||||
| | | ├── /test-files # solr test data directory and test solr location.
|
||||
```
|
Reference in New Issue
Block a user