Table of Contents

1. Introduction
2. Features
3. Installation
4. Team
5. Demo
6. [Gulp Workflow](#Gulp Workflow)

Introduction

Troupon is a Groupon clone. Users are able to buy products and services at a discounted price.

Features

• Users can search for deals by cities.
• Users can view maps of deals.
• Users can search for deals by categories.

Installation

• Clone repo: $ git clone https://github.com/andela/troupon.git

• Checkout to branch develop: $ git checkout develop

• Create a .env.yml file in your root directory. In it put the following key - value pairs:

   sendgrid_apikey:
     'your_sendgrip_apikey_here'
   SECRET_KEY:
     'your_secret_key_here'
   cloudinary_api_key:
     'your_cloudinary_api_key_here'
   cloudinary_api_secret:
     'your_cloudinary_api_secret_here'
   cloudinary_cloud_name:
     'your_cloudinary_cloud_name_here'
   DB_USER:
     'your_db_user_here'
   DB_PASSWORD:
     'your_db_password_here'
   NEXMO_PASSWORD: your_nexmo_password_here
   NEXMO_USERNAME: your_nexmo_password_here
   OTP_SECRET_KEY:
     'your_otp_secret_key_here'
   STRIPE_SECRET_API_KEY:
     'your_stripe_secret_api_key_here'
   STRIPE_PUBLISHABLE_API_KEY: 
     'your_stripe_publishable_api_key_here'	

  Important: the secret key must be of length 16, 24 or 32 bytes.

• Create a virtual environment $ workon [name_of_virtual_environment].

• Run $ pip install -r requirements.txt to install all dependencies.

• Ensure npm and bower are installed in your environment.

• Run $ bower install in the project root folder.

• Navigate to the troupon directory $ cd troupon/

• Run $ python manage.py collectstatic to collect static files.

• Run $ python troupon/manage.py runserver to start the server.

• With that you can view the project in your browser via http://127.0.0.1:8000/.

Sass Setup

The codebase also includes the Sass build files used to style/theme the application. These can be found in the troupon/static/scss folder. Follow the steps below to setup gulp and gulp-sass for automated pre-processing of the scss files to css stylesheets:

• Ensure npm is installed in your environment.
• Run $ npm install in the project root folder. This installs gulp, gulp-sass and it's other dependencies into the project.
• Run $ gulp command for the initial Sass build as well as to start the 'watch' task responsible for pre-processing subsequent changes the Sass scss files.

To extend this Sass build with your own Sass styles:

• Write them in a Sass partial (.scss file named starting with an underscore e.g _merchants.scss) and save it in the troupon/static/scss/partials folder.

• Import the partial at the end the base_styles.scss file. e.g

  ...
  @import "partials/_merchants";
  

Team

• Oluwatosin Adesanya
• Samuel James
• Oluwafemi Sule
• Awili Uzo
• Amos Omondi
• Penina Wanjiru
• Jack Mwangi

###Gulp Workflow #####Package.json

"devDependencies": {
    "gulp": "^3.9.0",
    "gulp-autoprefixer": "^3.1.0",
    "gulp-sass": "^2.1.0"
  }

Where all packacges to be used by Gulp are included for use when you create your tasks. In Troupon we include gulp,gulp-sass & gulp-autoprefixer for automating tasks,compiling sass to css & prefixing css respectively.

####Gulp setup:

#####gulp.js

Troupon has 3 tasks which are: 1.sass-compile -compiles scss files to css -source:'./troupon/static/scss/**/*.scss' -output:'./troupon/static/css';

2.Watch -Watch any files that are changed -watches :./troupon/static/scss/**/*.scss -logs the changes

Demo

View our live demo on heroku at http://troupon-staging.herokuapp.com/