Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/papachristoumarios/ntua-softeng
:money_with_wings: Price observatory to find the best bargains!
https://github.com/papachristoumarios/ntua-softeng
django django-rest-framework python software-engineering
Last synced: about 1 month ago
JSON representation
:money_with_wings: Price observatory to find the best bargains!
- Host: GitHub
- URL: https://github.com/papachristoumarios/ntua-softeng
- Owner: papachristoumarios
- License: mit
- Created: 2018-10-10T14:13:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-09T12:31:37.000Z (over 5 years ago)
- Last Synced: 2023-10-20T22:15:50.542Z (about 1 year ago)
- Topics: django, django-rest-framework, python, software-engineering
- Language: Python
- Homepage: https://cheapies.gr
- Size: 46.6 MB
- Stars: 12
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cheapies.gr
[](https://travis-ci.com/papachristoumarios/ntua-softeng)   
:money_with_wings: Price observatory to find the best bargains!
## :question: Project Description
This project aims to provide a web-based "price observatory", which will allow the users to post product prices from different stores. Volunteers will record the prices of various items and share them via the application.
Beyond the basic capabilities of product, store, time and space registration footprint and price as well as the facilities for their search, monitoring and opposition data (tables, charts, charts, etc.), special emphasis should be put on the possibility the interconnection of third-party applications with the observatory through appropriate web-based APIs.
_This repository hosts the [Software Engineering](https://courses.softlab.ntua.gr/softeng/2018b/) assignment for NTUA Course "Software Engineering" (Fall 2018)._
:snake: The application is developed using the Django Web Framework in Python 3.5.
## :mens: Team
This project was curated by "mycoderocks" team comprising of (alphabetical order):
* [Dimitris Christou](https://github.com/christou-dimitris) (AM: 03115058, [email protected])
* [Ioannis Daras](https://github.com/giannisdaras) (AM: 03115018, [email protected])
* [Dimitris Kelesis](https://github.com/jim113) (AM: 03115037, [email protected])
* [Marios Papachristou](https://github.com/papachristoumarios) (AM: 03115101, [email protected])
* [Ioannis Siachos](https://github.com/giannissiax) (AM: 03115109, [email protected])
* [Konstantinos Stavropoulos](https://github.com/stavropouloskonstantinos) (AM: 03115046, [email protected])
## :nut_and_bolt: Setup/Usage
The project comes with a Makefile for as a **build automation tool** for automating various tasks in the repository. Below there are some steps you need to get started using the project
An overview of available options can be obtained via
```bash
make help
```
### Step 1. Install Dependencies
You will need to install the dependencies required in order to have a functional project. This part comprises of both system-level dependencies (MySQL and GDAL) as well as Python dependencies. Install them via
``` bash
make deps
```
### Step 2. Setup MySQL database
The web application uses MySQL as a database for holding data.
1. Login into mysql from the command line and create the database
```sql
create database cheapies character set utf8;
```
2. Create a `database.cnf` file containing the following information
```
[client]
database = cheapies
user = user
password = password
default-character-set = utf8
```
3. __Optional__ if you are in a testing environment (e.g. Travis CI) you can fake a database via `make test_db`.
4. Make the needed migrations and compile messages with
```bash
make migrate
```
### Step 3. Populate the database with data
There is a Makefile inside the root directory designated to fill in the database with data using
crawled data from the Internet as well as the OSM Nominatim API. You can use it with:
```bash
make data
```
Clean uneeded data
```bash
make clean
```
###
### Run the development webserver
Then you can run the webserver with
```bash
python3 manage.py runserver
```
### Building a Docker Image
This project can be dockerized. The configuration is located at `Dockerfile` and `docker-compose.yml`
1. Build the docker image using `docker-compose`
```bash
export DOCKER_HOST=127.0.0.1
```
2. Run the image with
```bash
sudo docker-compose up
```
Or use the `make dockerize` from the provided Makefile
## :hammer: Technologies Used
* Back-end
* Python v3.5
* Django v2.1
* MySQL v14.14
* Django REST Framework
* Google Maps Geocoding API
* Front-end
* Bootstrap v4.1.3
* Tachyons v4.1
* wow.js
* Mapbox v0.5
* jQuery
* slick.js
* Deployment
* Gunicorn
* nginx
* Docker
* Continuous Integration & Unit Testing
* Travis CI
* Selenium (Browser-based testing)
* Locust.io (RESTful API Testing)
* Build Automation
* GNU Make
## :newspaper: Guidelines
### Language
The application language is [Greek](https://en.wikipedia.org/wiki/Greek_language).
### Code Formatting
* Back-end: [PEP8](https://www.python.org/dev/peps/pep-0008/) and [Django Coding Style](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/)
* Front-end: [Bootstrap CSS Coding Standards](http://www.w3big.com/bootstrap/bootstrap-css-codeguide-html.html)
### Creating a view
When creating a view, let's say `example` you should notice the following things:
* The view name matches the template name, so you should create `example.html`
* If you use any static JS code, place it into `/static/js/example.js` file.
* The main styling should go into `/static/main.css`. Inside the HTML file you should declare
```html
{% extends layout.html %}
{% block content %}
{% endblock %}
```
and inside `main.css` you should declare
```css
section.example {
.a {
/* CSS Formatting of a inside example */
}
}
```
for view-specific CSS. Otherwise, you should put it inside `main.css`
## :heavy_plus_sign: Contributing Workflow
We are using the [Git Branch Workflow](https://es.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). In the future we will migrate to [fork & pull-request](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow. The project status is kept inside [GitHub Projects](https://github.com/papachristoumarios/ntua-softeng/projects) following the [Kanban System](https://en.wikipedia.org/wiki/Kanban)
The project tasks are [tracked with GitHub projects](https://github.com/papachristoumarios/ntua-softeng/projects) following the [Kanban Scheduling Methodology](https://en.wikipedia.org/wiki/Kanban).
### Project Structure
* `docs/` Project-level documentation needs to be stored here and be written in Markdown. Module-specific documentation may be located only in source files.
* `etc/` Extra files that accompany the project, such as configuration of external tools etc.
* `/` Django applications that reside inside the project
* `/urls.py` Application-level urls
* `/views.py` Application-level views
* `/models.py` Application-level models
* `/templates/` HTML Templates
* `/static/{css, js}/{file.css, file.js}` CSS and JavaScript Static files
* CSS Static files contain a `main.css` that contains the basic CSS for the web application
* JS Static files are organized per view (e.g. `product.js` refers to `product.html`).
* `project/`
* `urls.py` Top-level routing instructions.
* `manage.py` Django command-line tool.
* `_version.py` Contains a `__version__` variable to indicate the current version of the website. Semantic versioning is used.
* `setup.py` Setup script.
* `requirements.txt` Pinned production dependencies.