diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 30 insertions, 16 deletions
@@ -1,48 +1,62 @@ Pixelated User Agent ==================== +[](https://snap-ci.com/pixelated-project/pixelated-user-agent/branch/master) The Pixelated User Agent is the mail client of the Pixelated ecosystem, it is composed of two parts, a web interface written in javascript and an API written in python that glues that interface with the Pixelated or LEAP Provider. ->**The Pixelated User Agent is still in early development state!** +**The Pixelated is still in early development state!** ->Some things may not yet work the way you expect it to. ->Setting up the service is still rather troublesome and so far it only serves limited functionality. + - +## Getting started -## Getting started for development +### Registering with a provider -First of all, you should have an account on a LEAP/Pixelated provider with email support. - * You can use one of the demo accounts at [Try Pixelated](https://try.pixelated-project.org:8080/auth/login). + * You can create a developer account at our [Dev Provider](https://dev.pixelated-project.org/). * There are some other LEAP providers on the [Bitmask page](https://bitmask.net), but they don't support email currently. + * If you want to run your own provider, see [pixelated-platform](https://github.com/pixelated-project/pixelated-platform). -Requirements: +### Requirements * vagrant * virtualbox Clone the repository: git clone https://github.com/pixelated-project/pixelated-user-agent.git + cd pixelated-user-agent -From the root folder, set up the vagrant machine: +From the project root folder, set up the vagrant machine: vagrant up source -You can log into the machine using: +You can log into the machine and view project root folder with: vagrant ssh - -From here on you can run the tests for the UI by going to the web-ui folder or for the API by going to the service folder and running: +From here on you can run the tests for the UI by going to the **web-ui** folder or for the API by going to the **service** folder: + cd /vagrant/web-ui ./go test -You can also run the mail client with: + cd /vagrant/service + ./go test +Running the user agent: + +``` +$ pixelated-user-agent --host 0.0.0.0 +> 2015-01-23 11:18:07+0100 [-] Log opened. +> 2015-01-23 11:18:07+0100 [-] Which provider do you want to connect to: +dev.pixelated-project.org +> 2015-01-23 11:18:52+0100 [-] What's your username registered on the provider: +username +> Type your password: +******************* +``` - pixelated-user-agent --host 0.0.0.0 +As soon as the agent starts you will be asked for username, password and the [provider you registered with](https://github.com/pixelated-project/pixelated-user-agent/blob/master/README.md#registering-with-a-provider). -Then point your browser to [http://localhost:3333](http://localhost:3333) to see it running. +Now you can see it running on [http://localhost:3333](http://localhost:3333) -## Getting started as an user +##Debian package For people that just want to try the user agent, we have debian packages available in our [repository](http://packages.pixelated-project.org/debian/). To use it you have to add it to your sources list: |