Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more subsections to README #87

Merged
merged 1 commit into from Nov 25, 2018
Merged

Add more subsections to README #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.rst
View file
Open in desktop
@@ -1,3 +1,4 @@
=================
Opwen cloudserver
=================

Expand All @@ -13,6 +14,7 @@ Opwen cloudserver
.. image:: https://codecov.io/gh/ascoderu/opwen-cloudserver/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ascoderu/opwen-cloudserver

------------
What's this?
------------

Expand All @@ -30,6 +32,7 @@ and has two main responsibilities:

More background information can be found in the `opwen-webapp README <https://github.com/ascoderu/opwen-webapp/blob/master/README.rst>`_.

---------------
System overview
---------------

Expand All @@ -39,6 +42,7 @@ System overview
:alt: Overview of the Lokole system
:target: https://user-images.githubusercontent.com/1086421/42739204-67798f44-8847-11e8-9613-312a860cfb1e.png

--------------------
Data exchange format
--------------------

Expand All @@ -60,6 +64,7 @@ describes an email, using the following schema:
"attachments": [{"filename": "string", "content": "base64"}]
}

-----------------
Development setup
-----------------

Expand Down Expand Up @@ -98,6 +103,9 @@ After installing Docker, you can run the application stack with one command:

docker-compose up --build

Finding your way around the project
===================================

There are OpenAPI specifications that document the functionality of the
application and provide references to the entry points into the code
(look for "some-api-name-spec.yaml" files in the repository). The various
Expand Down Expand Up @@ -149,6 +157,9 @@ leveraging any cloud services. For most development purposes this is fine
but if you wish to set up the full end-to-end stack that leverages the
same services as we use in production, keep on reading.

Integration setup
=================

The project uses Sendgrid, so to emulate a full production environment,
follow these `Sendgrid setup instructions <https://sendgrid.com/free/>`_ to
create a free account and take note of you API key for sending emails.
Expand Down Expand Up @@ -201,8 +212,9 @@ following command:

docker-compose -f docker-compose.yml -f docker-compose.secrets.yml up --build

Production setup
----------------
---------------------
Production deployment
---------------------

To set up a production-ready deployment of the system, follow the development
setup scripts described above, but additionally also pass the following
Expand Down