Add import service step to docs

Add a quick installation to README.rst

Signed-off-by: ziadhany <[email protected]>

Makefile

@@ -67,7 +67,6 @@ docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
-
 postgres:
 	@echo "-> Configure PostgreSQL database"
 	@echo "-> Create database user '${POSTGRES_DB}'"
@@ -83,4 +82,8 @@ migrate:
 	@echo "-> Apply database migrations"
 	${MANAGE} migrate
 
-.PHONY: conf dev check valid black isort clean test docs envfile postgres migrate
+run:
+	@echo "-> Starting development server"
+	${MANAGE} runserver
+
+.PHONY: conf dev check valid black isort clean test docs envfile postgres migrate run

README.rst

@@ -1,13 +1,21 @@
 FederatedCode
 ================================
-FederatedCode is a ...
+FederatedCode is a decentralized, federated metadata about software applications
 
 Usage
 =====
 Getting started
---------------------------------------------
-...
+-----------------
 
+Quick Installation
+===================
+On a Debian system, use this::
+    sudo apt-get install  python3-venv python3-dev postgresql libpq-dev build-essential
+    git clone https://github.com/nexB/federatedcode.git && cd federatedcode
+    make dev envfile postgres
+    make test
+    source venv/bin/activate
+    make run
 
 Acknowledgements
 ^^^^^^^^^^^^^^^^

docs/source/contribute/installation.rst

@@ -165,6 +165,20 @@ You can validate your federatedcode installation by running the tests suite::
 
     make test
 
+Import a Service like ( VCIO , .. )
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Create a Superuser::
+
+    python manage.py createsuperuser
+
+Create a Service:
+
+using django-admin panel create user as service admin then create a Service 'vcio'
+login using service admin credential then create a new git repository ex: https://github.com/nexB/vulnerablecode-data
+
+Create a Sync request and Import git repository data:
+click on the sync button under the git repository url then run: ``python manage.py tasks sync``
+
 
 Web Application
 ^^^^^^^^^^^^^^^