Summer of Code/2013/Social Sugar project/Documentation

From Sugar Labs
< Summer of Code‎ | 2013‎ | Social Sugar project
Revision as of 14:48, 31 July 2013 by Axitkhurana (talk | contribs) (Introduction and simple instructions for testing)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Social Sugar

Social Sugar project involves development of GUI components that can help bring user's social interactions on external platforms into Sugar.

The first component we've are working on are the mini profiles.

Mini Profiles

Mini Profiles extend Web Service code adding stubs to Account factory class for getting public id and getting latest posts from web service.

Testing

You can test the current implementation by following these steps:

  1. Set up your Sugar development environment
  2. Clone the social-sugar branch from following repositories replacing the appropriate modules in your sugar-build code:
    1. Sugar
    2. Sugar Toolkit GTK 3
    3. Sugar Artwork
  3. Clone the contents of mock-service repository inside ~/.sugar/default. You'll end up with the directory structure as shown below.
  4. Build Sugar and add Akshit Khurana (or other people running the service) as a friend from the neighbourhood view(F1). You can use the search to find people.
  5. Checkout the Friend view(F2).
    1. Click on the small cloud icon over the buddy icon, to view my latest mock-post!
    2. You should see something like: "Designed from the ground up especially for children, Sugar offers an alternative to traditional "office-desktop" software. Id: 458" in a giant speech bubble like cloud.
  6. Congratulations! You've got mock service running on Mini Profiles.

Directory Structure

~/.sugar/default/extensions/webservice/
├── __init__.py
└── mock-service
    ├── __init__.py
    ├── account.py
    ├── mock-service
    │   ├── __init__.py
    │   └── mock-service.py
    └── icons
        └── mock-service.svg

~/.sugar/default/extensions/cpsection/
├── __init__.py
└── webaccount
    ├── __init__.py
    └── services
        ├── __init__.py
        └── mock-service
            ├── __init__.py
            └── service.py