##Overview This is an open-source Javascript-based console application for Usergrid called the admin portal. The admin portal is the primary administrative user interface for working with Usergrid.
The admin portal source code is fully open source and forkable. You can easily extend the admin portal, embed it into your own applications, or inspect the code to learn best practices associated with the Usergrid API.
The admin portal source is in the Usergrid repo here:
https://github.com/apache/usergrid/tree/master/portal
##About the Admin Portal Use the admin portal for administrative operations, including:
##Running, Deploying, or Developing
If you are just running the portal:
./build.sh dev
.If you are deploying the portal to a server:
./build.sh
.If you are developing:
./build.sh dev
../build.sh
again and this will run “grunt build” in the background.If you want to run the e2e tests:
./build.sh e2e
.To version open a terminal and run ‘npm version x.x.x’ this will add a tag and increment the package.json.
If you are building via maven:
mvn clean install
to create the bundle.mvn clean install -Dbuild.mode=e2e
or mvn clean install -Dbuild.mode=dev
.##Using a Different API location You can change the API URL that the portal uses in several ways. For example, if your Usergrid is not running locally or if you have changed how it runs by default.
Edit the config.js located in the root. Locate and change the following line to point to your Usergrid install:
Usergrid.overrideUrl = ‘https://localhost:8080’;
Append the api_url query parameter to the end of the portal's URL path. In the example below, you are running the portal using the method above and it is running on http://localhost:3000
http://localhost:3000?api_url=http://path.to.another.usergrid.install
##Viewing API Calls as cURL Commands You can view the equivalent cURL syntax for each API call that is made through the Admin portal. The calls are displayed in the console area of any of the following browsers: Chrome, Internet Explorer (in the debugger), Firefox (in Firebug), and Safari.
More information on cURL can be found here:
You can also use the Usergrid Command Line (ugc) for terminal access to the Usergrid API. ugc provides simplified access to Usergrid. For more about ugc, see the Usergrid repo:
https://github.com/usergrid/usergrid
##Unit Tests Unit Tests
We welcome your enhancements!
The Admin Portal is part of the Usergrid, project. It is open source and licensed under the Apache License, Version 2.0.
git checkout -b my-new-feature
)git commit -am 'Added some feature'
)git push origin my-new-feature
)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.