Skip to content

Commit 1b43616

Browse files
committed
Updated docs
1 parent 9e76d6c commit 1b43616

File tree

4 files changed

+28
-1
lines changed

4 files changed

+28
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ Barebones Python Microservices
88
[![Python 3](https://pyup.io/repos/github/python-microservices/microservices-scaffold/python-3-shield.svg)](https://pyup.io/repos/github/python-microservices/microservices-scaffold/)
99

1010

11+
# How to run the scaffold
12+
13+
```bash
14+
python manage.py runserver
15+
16+
```
17+
18+
Open in your browser http://localhost:5000/template/ui/
19+
20+
Read more info in the documentation page: https://microservices-scaffold.readthedocs.io/en/latest/
1121

1222
# Docker
1323

docs/codeexample.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
Code Examples
22
=============
33

4+
See simple examples in https://github.com/python-microservices/pyms/tree/master/examples

docs/quickstart.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
Quickstart
22
==========
33

4+
Scaffold
5+
--------
6+
7+
Clone and start this scaffold
8+
49
.. code-block:: bash
510
git clone https://github.com/python-microservices/microservices-scaffold.git
611
cd microservices-scaffold
712
python manage.py runserver
13+
14+
15+
Open in your browser http://localhost:8080/template/ui/
16+
17+
Template
18+
--------
19+
20+
You can create your own project from template:
21+
22+
https://github.com/python-microservices/microservices-template

docs/structure.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ You have a project with this structure:
88
Dockerfile
99
LICENSE
1010
manage.py
11+
config.yml
1112
README.md
1213
requirements.txt
1314
requirements-tests.txt
@@ -18,7 +19,6 @@ You have a project with this structure:
1819
tox.ini
1920
project
2021
├ __init__.py
21-
├ config.py
2222
├ models
2323
│ ├ __init__.py
2424
│ └ models.py
@@ -48,6 +48,7 @@ You can set the host and the port with:
4848
4949
python manage.py runserver -h 0.0.0.0 -p 8080
5050
51+
5152
Common Libraries
5253
----------------
5354

0 commit comments

Comments
 (0)