diff options
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | fake-service/README.md | 2 | ||||
| -rw-r--r-- | inboxapp-service/README.md | 47 | ||||
| -rw-r--r-- | service/README.md | 37 | ||||
| -rw-r--r-- | service/keep | 0 | ||||
| -rw-r--r-- | web-ui/README.md | 2 |
6 files changed, 41 insertions, 51 deletions
@@ -0,0 +1,4 @@ +Pixelated User Agent +==================== + +This contains the Pixelated User Agent, which is composed of a web UI written as a JavaScript single page app, and a service that provides a REST-ful interface that the UI can use for all User Agent actions. For now, all of these actions are mail-related but this might evolve later. The default service is written to talk to a Pixelated or LEAP provider. diff --git a/fake-service/README.md b/fake-service/README.md deleted file mode 100644 index 269f0df0..00000000 --- a/fake-service/README.md +++ /dev/null @@ -1,2 +0,0 @@ -fake-smail-back -=============== diff --git a/inboxapp-service/README.md b/inboxapp-service/README.md index f30da482..a3eeb66a 100644 --- a/inboxapp-service/README.md +++ b/inboxapp-service/README.md @@ -1,50 +1,3 @@ -SMail Back -========== - -This is the backend for SMail. The primary purpose of this is to integrate well with LEAP and provide all the capabilities necessary for the frontend to work well. - -The aim is to support these resources/endpoints: - -``` -GET /mails -DELETE /mails -POST /mails -PUT /mails -POST /mails/read - -GET /mail/:id -DELETE /mail/:id -POST /mail/:id/star -POST /mail/:id/unstar -POST /mail/:id/replied -POST /mail/:id/unreplied -POST /mail/:id/read -POST /mail/:id/unread -GET /mail/:id/tags -POST /mail/:id/tags - -GET /draft_reply_for/:id - -GET /contacts -GET /contact/:id - -GET /stats - -GET /tags -POST /tags -``` - -The implementation of SMail Back will be in Python, in order to better work together with LEAP. Another goal of SMail Back will be to run well on all major client platforms. Finally, there will be a lot of support for search and indexing, and also for encryption and signing. However, we want to push most of these features back to LEAP so that Bitmask can leverage them as well. - -We will likely start by implementing a simple SMTP and IMAP implementation in order to make it easier to test - and we will then gradually implement a LEAP backend that provides the production functionality we are aiming for. - -Instructions -=== - -To run the app we suggest you using python + virtualenv. If you are developing in with TW Brazil you can fetch a vagrant base box from secret.local:~/smail-back-precise64.box. - Inboxapp as provider --- You will need to install inboxapp in your machine and sync an account to it. Follow instructions from inboxapp [instalation](https://www.inboxapp.com/docs/gettingstarted#installation) guide. Once you have an account sync you can configure it in config/inboxapp.cfg and you should be good to go. - - diff --git a/service/README.md b/service/README.md new file mode 100644 index 00000000..971b1494 --- /dev/null +++ b/service/README.md @@ -0,0 +1,37 @@ +Pixelated User Agent Service +============================ + +This is the service for the Pixelated User Agent. The primary purpose of this is to integrate well with the Pixelated Provider and provide all the capabilities necessary for the UI to work well. + +The aim is to support these resources/endpoints: + +``` +GET /mails +DELETE /mails +POST /mails +PUT /mails +POST /mails/read + +GET /mail/:id +DELETE /mail/:id +POST /mail/:id/star +POST /mail/:id/unstar +POST /mail/:id/replied +POST /mail/:id/unreplied +POST /mail/:id/read +POST /mail/:id/unread +GET /mail/:id/tags +POST /mail/:id/tags + +GET /draft_reply_for/:id + +GET /contacts +GET /contact/:id + +GET /stats + +GET /tags +POST /tags +``` + +The implementation of the User Agent Service will be in Python, in order to better work together with LEAP. Another goal of the User Agent Service will be to run well on all major client platforms. Finally, there will be a lot of support for search and indexing, and also for encryption and signing. However, we want to push most of these features back to LEAP so that Bitmask can leverage them as well. diff --git a/service/keep b/service/keep deleted file mode 100644 index e69de29b..00000000 --- a/service/keep +++ /dev/null diff --git a/web-ui/README.md b/web-ui/README.md deleted file mode 100644 index 74dadb95..00000000 --- a/web-ui/README.md +++ /dev/null @@ -1,2 +0,0 @@ -smail-front -=========== |