fly-django

Description

An open-source, cross platform, mobile app, supported by a Django/Python web service, which is meant to teach youth financial literacy in multiple languages, while also introducing them to the concept of entrepreneurship.

Support

You can support this project by testing the app, submitting tickets via GitHub, and sharing this app via social media.

Features

Users can login with social media accounts
Supports educational videos
Allows user to set and track financial goals
Gamification elements, such as badges, levels and XP

System Requirements

Python 3.5.x+
Postgres SQL DB 9.6+

Dependencies

See requirements.txt for more information.

Build Instructions

Application

For Linux, FreeBSD and MacOS users, run these commands:

First clone the project locally and then go into the directory

git clone https://github.com/Oinweb/fly-django.git
cd fly-django

Setup our virtual environment

MacOS Environment:
```
python3 -m venv env
```
FreeBSD Environment:
```
virtualenv env
```
Activate virtual environment
```
source env/bin/activate
```
MacOS USERS ONLY: If you are using Postgres.app, you’ll need to have pg_config setup in your $PATH. If you already have set this up, skip this step, else simply run this command in the console to set the path manually.
```
export PATH="/Applications/Postgres.app/Contents/Versions/9.4/bin:$PATH"
```
Now lets install the libraries this project depends on.
```
pip install -r requirements.txt
```

Database

We are almost done! Just follow these instructions and the database will be setup for the application to use. Load up your postgres and enter the console. Then to create our database, enter:

MacOS Environment:

  create database fly_db;
  \c fly_db;
  CREATE USER django WITH PASSWORD NULL;
  GRANT ALL PRIVILEGES ON DATABASE fly_db to django;
  ALTER USER django CREATEDB;

FreeBSD Environment:

  /usr/local/bin/dropdb fly_db;
  /usr/local/bin/createdb fly_db;
  /usr/local/bin/psql fly_db;
  CREATE USER freebsd WITH PASSWORD NULL;
  GRANT ALL PRIVILEGES ON DATABASE fly_db to freebsd;
  ALTER USER freebsd CREATEDB;

Static Files Hosting

Files are stored on a remote server. The service we are using is Amazon Amazon Simple Storage Service.

Email

Emails are handled by communicating with a third-party API-based emailing service. The service we are using is Mailgun.

Application + Database

Run the following command to create your custom settings instance. Note: Please write all your application passwords here as it won't be tracked on git.

  cd fly_project
  cp secret_settings_example.py secret_settings.py

Run the following commands to populate the database.

  cd ../
  python manage.py migrate
  python manage.py setup_fly

Usage

To run the web-app, you’ll need to run the server instance and access the page from your browser.

Start up the web-server:

  source env/bin/activate
  python manage.py runserver

In your web-browser, load up the following url

  http://127.0.0.1:8000/

Congratulations, you are all setup to run the fly-django! Have fun coding!

License

fly-django is licensed under the Simplified BSD License. See LICENSE for more information.

Oinweb / fly-django

readme