https://github.com/wmramadan/django-product-review-app

A simple application for reviewing products using django framework.
https://github.com/wmramadan/django-product-review-app

django docker docker-compose miniconda python

Last synced: 3 months ago
JSON representation

A simple application for reviewing products using django framework.

• Host: GitHub
• URL: https://github.com/wmramadan/django-product-review-app
• Owner: WMRamadan
• Created: 2020-02-11T23:47:43.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T22:46:32.000Z (about 2 years ago)
• Last Synced: 2024-05-01T17:58:37.470Z (10 months ago)
• Topics: django, docker, docker-compose, miniconda, python
• Language: Python
• Homepage:
• Size: 14.1 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Simple products review applicaiton using django

This application houses a list of products that can be reviewed by users. An admin can apply CRUD operations on products while a user can review products only if logged in.

## Requirements

- conda 4.12.0

- docker

- docker-compose

## Local Setup Instructions

The following instruction are for setting up and running the app locally.

### Environment Setup

Navigate to project folder and run the following to install the requirements:

    conda env create -f environment.yaml

Inside the project folder run the following command to activate the environment:

    conda activate django-product-review-app

Navigate to the project folder and run the following command for creating all database migrations:

    python3 manage.py migrate

Create your super user account with the following command inside the project directory:

    python3 manage.py createsuperuser

### Tests

Run all tests with the follwing command inside the project directory:

    python3 manage.py test

To run a test for a specific module use the following command inside the project directory and replace `` with the name of the module you want to run the test for such as `products`:

    python3 manage.py test 

### Launch App

Run the Python dev server with the following command inside the project directory:

    python3 manage.py runserver

## Docker Setup Instructions

The following instructions are for setting up and running the app using docker.

### Docker Build

Build the docker container with the following instructions, the container will need to be rebuilt with every code change:

    docker-compose build

### Launch App

Launch the docker container with the following command:

    docker-compose up