aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorxudan <xudan16@huawei.com>2018-07-06 05:16:40 -0400
committerxudan <xudan16@huawei.com>2018-07-06 05:21:42 -0400
commitb3e40f026d655501bfa581452c447784604ecb05 (patch)
tree406f8bfc1abc1b33f98153d03abd34ef7b0e2fe9 /README.rst
parentb1b0ea32d1a296c7d055c5391261dcad6be48c63 (diff)
Move all web portal code to the new repo dovetail-webportal
This is only the first step to simply copy the file here. There still need some more work to make sure all work well. All the changes will be submitted with other patches to make it easily to review. JIRA: DOVETAIL-671 Change-Id: I64d32a9df562184166b6199e2719f298687d1a0a Signed-off-by: xudan <xudan16@huawei.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..44ab2a4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,64 @@
+=============
+opnfv-testapi
+=============
+
+Test Results Collector of OPNFV Test Projects
+
+Start Server
+==============
+
+Getting setup
+^^^^^^^^^^^^^
+
+Requirements for opnfv-testapi:
+
+* tornado
+* epydoc
+
+These requirements are expressed in the requirements.txt file and may be
+installed by running the following (from within a virtual environment)::
+
+ pip install -r requirements.txt
+
+How to install
+^^^^^^^^^^^^^^
+
+From within your environment, just run:
+
+ ./install.sh
+
+How to run
+^^^^^^^^^^
+
+From within your environment, just run:
+
+ opnfv-testapi
+
+This will start a server on port 8000. Just visit http://localhost:8000
+
+For swagger website, just visit http://localhost:8000/swagger/spec.html
+
+Unittest
+=====================
+
+Getting setup
+^^^^^^^^^^^^^
+
+Requirements for unittest:
+
+* testtools
+* discover
+* futures
+
+These requirements are expressed in the test-requirements.txt file and may be
+installed by running the following (from within a virtual environment)::
+
+ pip install -r test-requirements.txt
+
+How to run
+^^^^^^^^^^
+
+From within your environment, just run::
+
+ bash run_test.sh
+