semillas / semillas_platform Goto Github PK

A transparent, nonprofit platform for the exchange of goods and services in which participation don't require legal tender involvement

Home Page: https://www.semillasocial.org

License: MIT License

Shell 2.78% Python 53.83% JavaScript 0.71% CSS 16.47% HTML 26.22%

participation django test-coverage social-currency rest-api django-rest-framework

semillas_platform's Introduction

semillas_platform

Social Currency

It is a transparent, nonprofit platform for the exchange of goods and services in which participation don't require legal tender involvement.

It is based on the abundancy of resources, in the creative, artistic, manual and intelectual capacity of members. They could be children, elder people, teenagers, workers, housewives, unemployed, etc.

We are a community of developers willing to learn. Join us and we will give you fully support.

Website: https://www.semillasocial.org
API Rest Endpoints: https://www.semillasocial.org/docs (You should be registered and signed-in)
Write us: [email protected]

Apps Distribution

In Django the term application describes a Python package that provides some set of features. Applications may be reused in various projects.

We have the following main ones:

services: It contains a basic Service entity: Some service being offered or for sale.
semillas_backend/users: The User's models and views
landing: Visible landing website. No logic. No models.
swagger: Preview for every API endpoint. Check it here: API
wallet: App responsible of user wallet and movements

Setting Up Your Development environment with Docker Compose

Linux

Install Docker Engine: For example, in Ubuntu I installed it following this: https://docs.docker.com/engine/installation/linux/ubuntulinux/
Install docker-compose: https://docs.docker.com/compose/install/ from step three
Add your user to docker group: usermod -aG docker ${USER}

Mac

Docker is native in Mac now. Drag and drop and enjoy.

Start Everything

Once docker compose is installed and running:

$ sudo docker-compose -f dev.yml up

Basic Commands

Run the migrations pending

Migrations are handled by Django. If you just set up your development environment probably there is a lot of migrations you have to run in your database so is in concordance with the models defined in the code.

See all migrations and which one is left to apply.

$ docker-compose -f dev.yml run django python manage.py showmigrations

Run all migrations with this command:

$ docker-compose -f dev.yml run django python manage.py migrate

Any change in any model can incur in a database migration. Check them here: https://docs.djangoproject.com/en/1.10/topics/migrations/

Setting Up Your Users

To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
To create an superuser account, use this command::

$ docker-compose -f dev.yml run django python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report::

$ docker-compose -f dev.yml run django coverage run manage.py test
$ docker-compose -f dev.yml run django coverage html
$ open htmlcov/index.html

Running tests with py.test

$ docker-compose -f dev.yml run django py.test

Live reloading and Sass CSS compilation

Live reloading and SASS compilation http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Mailhog: https://github.com/mailhog/MailHog

Container mailhog will start automatically when you will run all docker containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Error Log: Sentry

https://sentry.io/semillas

Deployment

Whenever master branch is updated with a new commit or merge. A deploy will be triggered. Check it on https://www.semillasocial.org

Whatever is pushed to 'dev' branch it will automatically be deployed to http://alpha.semillasocial.org

Gulp Workflow

Gulp Tasks: What they do

We have two Gulp tasks

After running any Gulp task enter the folder where you have "Semillas Social" and run the following command:

npm init=> This will download every NPM dependency to your local machine

Then run:

gulp default=> This task runs the following tasks:

css: converts .scss files to .css
cssnano: minifies css
autoprefixer: add prefixes to the last 4 browser version

gulp img=> This task removes unnecesary image's metadata (lossless compression)

Deploy another instance of Semillas to Heroku

This is useful in case you are creating your own currency app. Once you have created your own instance of the Client with https://github.com/Semillas/AlternativeCurrencyApp

heroku addons:create heroku-postgresql:hobby-dev --app bitcoin-bazaar
heroku addons:add heroku-redis:hobby-dev --app bitcoin-bazaar
heroku addons:add mailgun:starter --app bitcoin-bazaar
heroku addons:add newrelic:wayne --app bitcoin-bazaar
heroku buildpacks:add https://github.com/Semillas/heroku-buildpack-geolite.git --app bitcoin-bazaar
heroku buildpacks:add https://github.com/dschep/heroku-geo-buildpack.git --app bitcoin-bazaar
heroku buildpacks:add heroku/python --app bitcoin-bazaar
heroku addons:add papertrail:choklad --app bitcoin-bazaar
heroku pg:copy postgresql-flexible-86889 fully-qualified-dest-url-db --app semilla (This is in case you want to copy de DB, remember to copy the media folder in AWS S3 too)
heroku stack:set cedar-14 --app bitcoin-bazaar
heroku config:add DJANGO_SETTINGS_MODULE=config.settings.production --app bitcoin-bazaar
heroku config:add DJANGO_AWS_ACCESS_KEY_ID= --app bitcoin-bazaar
heroku config:add DJANGO_AWS_SECRET_ACCESS_KEY= --app bitcoin-bazaar
heroku config:add DJANGO_AWS_STORAGE_BUCKET_NAME=bitcoinbazaar --app bitcoin-bazaar
heroku config:add DJANGO_SECRET_KEY='' --app bitcoin-bazaar
heroku config:add DJANGO_SENTRY_DSN= --app bitcoin-bazaar
heroku config:add DJANGO_ADMIN_URL=^admin/ --app bitcoin-bazaar
heroku config:add DJANGO_ALLOWED_HOSTS=bitcoin-bazaar.herokuapp.com --app bitcoin-bazaar

semillas_platform's People

Contributors

Stargazers

Watchers

Forkers

josheriff iesteban jsoriano sergimartnez carquet kahihia nivratti podemosburlada

semillas_platform's Issues

Add Gallery of photos to Service model

Service is a service being offered in the platform or an item being sold.

We need to add a Gallery of photos to the Service model.

Add Google Login

https://django-allauth.readthedocs.io/en/latest/providers.html#google

Fix redirection for https://semillasocial.org

I can provide Godaddy credentials for this.

seems that the other three combinations are working:

I have this configuartion set up.

Maybe is needed to use deep DNS configuration, but we run in the problem that Heroku just gives you access to herokuapp.semilla.com, and no IP. And Godaddy just allows you to set A (only IP) register types in root (@) dns records.

Translate to spanish the software tab.

There are many string in English regarding each software been used.
Also there are some sentences below "version" title which need a proper tranlation as well.
It would be very nice if they get translated.

Create Categories Model

Fields:

Name
Photo (like in user model)
order (integer)

It'd would be a good idea to use modeltranslation app for translating the name: http://django-modeltranslation.readthedocs.io/en/latest/installation.html

Create endpoint for all selling/sold items for a user: /api/v1/user/<user_id>/services

This will be shown in the User Profile View. A list of every single service.

Is needed the following URLs:

/api/v1/user/<user_id>/services -> All the post that user is offering, setting first the active (order by post date), and after this the inactive.

Create Post endpoint for Service

Used when a user publish a new service.

http://www.django-rest-framework.org/api-guide/validators/
http://www.django-rest-framework.org/api-guide/parsers/#parsers

Allow user to Edit user profile and submit it

Request Geolocation by browser

It will be used afterwards in ReactJS to ask for the feed Endpoint to be done here:

Create User Method verify_pin

This will be called once the user has introduced the 4 digits he got (through SMS or last four digits of lost call).

Will call verify_pin from #58
Update phone_verified flag

Add a floating closeable banner at footer with cookies mandatory informative message

Add Category to Service

Add photo to User Model

Should be uploaded to S3

Switch footer's minicons from 'ico' or 'png' to 'svg'

Create Gallery for Service model and add it to serializer

PhotoService model will have:

service: foreign key to service (this way we achieve the one to many, many photos can be pointing to one service.
picture: models.ImageField(null=False, blank=False, ... )

Then they should be added to ServiceSerializer. And return them inside the json in a list ordered by id.
In the photos field. They can be added like in this example: http://www.django-rest-framework.org/api-guide/relations/#nested-relationships

PUT PATCH /user/<uuid>: Make users only can edit his profile

The View is UserDetail, but I think it's gonna need to be divided between RetrieveUserDetail and UpdateUserDetail

We can use this:

http://www.django-rest-framework.org/tutorial/4-authentication-and-permissions/#object-level-permissions

Upgrade to Django 1.10

Is needed to use search engines: https://docs.djangoproject.com/en/1.10/ref/contrib/postgres/search/

Create Wallet Model

Every user will have a wallet entity connected. The Wallet model can be taken from this one:
https://github.com/jpanganiban/django-pursed

I think the Transaction model should have also the source wallet of the transaction.

Wallet and Movement Serializer

Wallet Endpoint: POST wallet/transfer

Post Params:

Source: user_uuid
Destination: user_uuid
Quantity: int

Create User Model method: validate_phone

This will call CheckMobi service and verify the user implemented in #58

Parameter: phone properly formated (in the format CheckMobi requires)

Takes the phone properly formatted from the view
Saves the phone
Perform Request to CheckMobi
Return whether or not the CheckMobi Request was successful

Create Endpoint /user/verify_phone/verify_pin/<pin>

This will be called once the user has got the confirmation code.

Will call pin_verify method implemented in #58

Will return whether or not it was verified.

Make default language English

To every user not having the browser in English, the web is showing up in Spanish.

So anyone from... France for example opening the web, it will be in Spanish.

Also in order to have the strings inside the code written in English would be great to have the default language as English.

Wallet Endpoint: GET wallet

Param Url:

user: user_uuid

Create Service Model Admin Panel

Create Endpoint /user/verify_phone/<phone>

Responsible of formating properly the phone and calling #50 User.validate_phone

Create API Views for Posts (Item)

Endpoint for the feed of items (posts) the user will see:

-/api/v1/posts/feed -> The feed ordered by the location/publishing time of the user.
- URL parameters:
- Lat: Latitude to order by geolocation
- Lon: Longitude to order by geolocation
- category: Category id to filter by that category
- search: String to search item using that string

The default order should be by distance.

In the future, another get param can be order with two options: distance, recent

Add shell_plus to production

Wallet Endpoint: GET wallet/movements

All user movements ordered by date

Add React-Router

Call the backend User-detail and save it in the storage

Start ReactJS app

Prepare Landing 'sign-up' and 'successfully signed-up' pages for gathering e-mails

The goal is to encourage people to sign-up in our landing page with the promise of keeping them up to date and notify them as soon as we launch the first version of the product.

So the sign-up should include a text like:
"We are not live yet, but we can keep you updated of our improvements and notify you once we launch"

And the after sign-up page should have a message like:
"Thanks a lot for joining. We will keep you posted. Keep reading about us" And a link to 'people' tab.

Create tests for API on User

A simple test using the functionalities of django rest framework: http://www.django-rest-framework.org/api-guide/testing/

Run tests with:
$ docker-compose -f dev.yml run python manage.py test

More info in: https://docs.djangoproject.com/en/1.10/topics/testing/overview/

Create Main Endpoint: GET services/feed

PUT PATCH /service/uuid/: Only allow authors to edit his services

Show the User profile data

Translate to English: Contact and Last Member of team

Contact tab and a part of the team, is not translated.

It'd would be great to have it translated.

After is translated, it should be uploaded to Transifex.

Make uploaded files are stores inside media folder in AWS S3 bucket

create GET /categories endpoint, retrieves all categories

Create endpoint retrieving all categories:

endpoint: GET api/v1/categories

Check: /api/v1/services/all_services

Add OpenID Login

https://django-allauth.readthedocs.io/en/latest/providers.html#openid

Implement library with CheckMobi validation call and pin_verify

validate method will save in Redis the CheckMobi user identifier so verify_pin can retrieve it and perform the verification.

Create API documentation with django-rest-framework-docs

https://github.com/marcgibbons/django-rest-framework-docs

Add phone field and phone_verified to User model

Use this

https://github.com/stefanfoulis/django-phonenumber-field

phone_verified should be a not null default false boolean.

Add Facebook Login

https://django-allauth.readthedocs.io/en/latest/providers.html#facebook

Feed Page: Request Position from user and send it to server.

When loading the feed, it should get the user position from the browser.

If the user allows the browser to retrieve it, it will update the user with the coordinates (PATCH /user/) and request the feed again.

It should also update the User with the permission option chosen (Browser not supported, permission denied, permission allowed).

Change the language flag button jpg, to a svg or another hq rendered pic

Create Chat logic

Due to the match of technologies to use we should get inspired by:

https://github.com/iesteban/channel_chat

Avoiding the group chat.

Notes: Check out authentication.

Automate the configuration of social apps

Comes from #8 (comment) :

@iesteban says:

For the development environment, the approach I like the most is to create a script like populate_development_database. Which will be called every time we start the development environment.

That script, let's call it pre_start.py for example, will check there is an entry of a Facebook Provider in database and create if it's not there. Something like:

if not SocialApp.objects.filter(provider=Facebook):
facebook_provider = SocialApp(
provider=Facebook,
secret_key= '34567890',
...
)
facebook_provider.save()

And the place too call pre_start.py will be here: https://github.com/Semillas/semillas_backend/blob/master/compose/django/gunicorn.sh#L2

This will set the development key public. I think there is no problem at all. But maybe we should research a little bit.