Extrated Developer Setup On Native OS session
[pixelated-user-agent.git] / README.md
1 Pixelated User Agent
2 ====================
3
4 [![CircleCI](https://circleci.com/gh/pixelated/pixelated-user-agent.svg?style=svg)](https://circleci.com/gh/pixelated/pixelated-user-agent)
5 [![Coverage Status](https://coveralls.io/repos/pixelated/pixelated-user-agent/badge.svg?branch=master)](https://coveralls.io/r/pixelated/pixelated-user-agent?branch=master)
6 [![Stories in Doing](https://badge.waffle.io/pixelated/pixelated-user-agent.svg?label=doing&title=Doing)](http://waffle.io/pixelated/pixelated-user-agent)
7
8 The Pixelated User Agent is the email client of the Pixelated ecosystem. It is composed of two parts, a web interface written in JavaScript ([FlightJS](https://flightjs.github.io/) and [React](https://facebook.github.io/react/)) and a Python API that interacts with a [LEAP Provider](https://leap.se/), the email platform that Pixelated is built on.
9
10 Here's a [podcast](https://soundcloud.com/thoughtworks/pixelated-why-secure-communication-is-essential) that explains the project.
11
12 **Pixelated is still in early development state!**
13
14 ![High level architecture User Agent](https://raw.githubusercontent.com/pixelated/website/master/assets/images/pixelated-user-agent.png)
15
16 ## Getting started
17
18 You are most welcome to contribute to the pixelated user agent code base. Please have a look at the [contributions how to](https://github.com/pixelated/pixelated-user-agent/blob/master/CONTRIBUTING.md).
19
20 ## Installing Pixelated
21
22 To run your own instance of Pixelated, follow these instructions: https://github.com/pixelated/puppet-pixelated#manual-installation
23
24 ## Development
25
26 If you want to run and test it locally, then before you have to install the following dependencies:
27
28 * [Vagrant](https://www.vagrantup.com/downloads.html), Vagrant is a tool that automates the setup of a virtual machine with the development environment
29 * A vagrant [compatible provider](https://www.vagrantup.com/docs/providers/), e.g. [Virtual Box](https://www.virtualbox.org/wiki/Downloads).
30
31 ### Option 1: Run Pixelated User Agent against an existing LEAP provider
32
33 1) If you don't have access to an existing LEAP provider, you can create an account at [Bitmask mail demo provider](https://mail.bitmask.net/).
34
35 2) Clone the Pixelated User Agent repo and start the virtual machine (downloads 600MB, you may want get a coffee or tea in the meantime):
36
37 ```
38 $ git clone https://github.com/pixelated/pixelated-user-agent.git
39 $ cd pixelated-user-agent
40 $ vagrant up
41 ```
42
43 3) Log into the VM:
44 * You can access the guest OS shell via the command `vagrant ssh` run within the `pixelated-user-agent/` folder in the host OS.
45 * /vagrant/ in the guest OS is mapped to the pixelated-user-agent/ folder in the host OS. File changes on either side will reflect in the other.
46
47 ```
48 $ vagrant ssh
49 $ cd /vagrant
50 ```
51
52 4) Start the pixelated user agent:
53
54 ```
55 $ pixelated-user-agent --host 0.0.0.0 --multi-user --provider=mail.bitmask.net
56 ```
57
58 5) Go to [localhost:3333](http://localhost:3333/) on your browser. You should see the login screen, where you can put your username and password created on step 1. Once you login, you'll see your inbox.
59
60 First time email sync could be slow, please be patient. This could be the case if you have a lot of emails and it is the first time you setup the user agent on your machine.
61
62 #### How to get start with development?
63
64 See the [Starting Development page](https://github.com/pixelated/pixelated-user-agent/wiki/Starting-Development)
65
66 ### Option 2: Pixelated User Agent + Leap Platform
67
68 You can install the Pixelated User Agent and the Leap Platform at once, just by running the following command on your console (this may take a while, please be patient):
69
70 ```bash
71  curl https://raw.githubusercontent.com/pixelated/puppet-pixelated/master/vagrant_platform.sh | sh
72 ```
73
74  Once installed, you can create accounts by visiting the LEAP Webapp at [localhost:4443/signup](https://localhost:4443/signup) and see Pixelated in action at [localhost:8080](https://localhost:8080/).
75
76  NOTE: Be aware that you will not be able to send mails outside, but you can test sending mails internally from one user to another.
77
78
79 ## Debian package
80
81 If you just want to try the user agent with debian packages. See [this page](https://github.com/pixelated/pixelated-user-agent/wiki/Debian-package).
82
83 ## Running tests
84
85 [Here](https://github.com/pixelated/pixelated-user-agent/wiki/Running-Tests) you will find informations about how to run Pixelated tests.
86
87 # Further Notes
88
89 ## Multi User Mode
90
91 To run the pixelated user agent multi user mode, please run the following:
92 ```bash
93  vagrant@jessie:/vagrant$ pixelated-user-agent --host 0.0.0.0 --multi-user --provider=dev.pixelated-project.org
94 ```
95
96 You will need to change `dev.pixelated-project.org` to the hostname of the leap provider that you will be using.
97 Once that is done, you can use by browsing to [http://localhost:3333](http://localhost:3333), where you will be prompted for your email username and password.
98
99 ## Config file with credentials
100
101 Create a config file with `ini` format in the root directory, see the example:
102
103 *credentials.ini*
104 ```
105 [pixelated]
106 HOST=0.0.0.0
107 PORT=8080
108 leap_server_name=<your_provider>
109 leap_username=<your_username>
110 leap_password=<your_password>
111 ```
112 Host and port is optional.
113
114 To use it, start the user agent like this:
115 `$ pixelated-user-agent --host 0.0.0.0 --config credentials.ini`
116
117
118
119 ## How to translate the user interface
120
121 See: [Translating Pixelated](https://github.com/pixelated/pixelated-user-agent/wiki/Translating-Pixelated)
122
123 ## More informations
124
125 Read the [wiki pages](https://github.com/pixelated/pixelated-user-agent/wiki)