An open API service indexing awesome lists of open source software.

https://github.com/arsho/mobilemate


https://github.com/arsho/mobilemate

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

mobilemate
==========

[![Build Status](https://travis-ci.org/arsho/mobilemate.svg?branch=master)](https://travis-ci.org/arsho/mobilemate)
[![Size](https://img.shields.io/github/size/arsho/mobilemate/app.py.svg?)](https://github.com/arsho/mobilemate/)
[![Codecov](https://codecov.io/github/arsho/mobilemate/coverage.svg?branch=master)](https://codecov.io/github/arsho/mobilemate)

*Development Status :: 1 - Planning*

![App demo](Screenshot/demo_original_crop.png)

App description goes here. See live [https://mobilemate.herokuapp.com/](https://mobilemate.herokuapp.com/)

## Software Environment

The following environment is used to develop the application:

- **OS** : Windows 8.1 (64 bit)
- **IDE** : PyCharm Professional (Version: 2017.2.3)
- **Python** : 3.6.2 (64 bit)

### Necessary Package Installation

- Install virtual environment

$ python -m virtualenv venv

- Activate virtual environment (Change it based on your OS)

$ venv\Scripts\activate.bat

- Install necessary packages included in `requirements.txt`

$ pip install -r requirements.txt


### To Run the Application

- Activate virtual environment (if not activated)

$ venv\Scripts\activate.bat

- Run the `app.py`

$ python app.py


### Unit testing

- Activate virtual environment (if not activated)

$ venv\Scripts\activate.bat

- Run the `tests.py`

$ python tests.py

![Unittests](Screenshot/unittests.png)

### What is this repository for?

- Quick summary
- Version Controlling
- Screenshot enlisting of each phase (See attached Screenshot folder)
- [Issue Tracking](https://bitbucket.org/arsho/mobilemate/issues)

## Acknowledgments

- Demo acknowledegement