Skip to content

Latest commit

 

History

History
178 lines (110 loc) · 7.66 KB

README.md

File metadata and controls

178 lines (110 loc) · 7.66 KB
Raw

semillas_platform

Built with Cookiecutter Django MIT License Travis-CI Coverage Codecov Updates Codacy Badge

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.

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

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