From ffa26d5a983486401e5cd00e6e9f6cab3d100c17 Mon Sep 17 00:00:00 2001 From: Saad Mairaj <46227224+Saadmairaj@users.noreply.github.com> Date: Fri, 9 Apr 2021 13:39:55 +0530 Subject: [PATCH] Create README.md --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..d98a3d3a --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# django-rate-your-review + +[![CodeFactor](https://www.codefactor.io/repository/github/saadmairaj/django-rate-your-review/badge/master)](https://www.codefactor.io/repository/github/saadmairaj/django-rate-your-review/overview/master) + + +An online application that will give a rating to your reviews. + +

+ Screenshot 2021-04-09 at 13 31 57 + Screenshot 2021-04-09 at 13 30 36 +

+ +## Requirement + +Install all the requirements with [requirements.txt](https://github.com/Saadmairaj/django-rate-your-review/blob/master/requirements.txt) with the command + +```bash +pip install -r requirements.txt +``` + +Main packages used in the application are: + + - Django + - django-crispy-forms + - tensorflow + + ## Installation + + Install and run the server in 5 simple steps. + + - *Step 1:* Clone the repository. + + - *Step 2:* Create a virtual environment in the cloned directory with the following command: + ```bash + python3 -m venv env + ``` + + Note: If you get an error saying venv doesn't exist then install venv first with command [`pip install virtualenv`](https://pypi.org/project/virtualenv/). + + - *Step 3:* After creating the virtual environment, activate it with command: + ```bash + source ./env/bin/activate + ``` + + - *Step 4:* Now install the requirements into the virtual environement `evn` with command: + ```bash + pip install -r requirements.txt + ``` + + - *Step 5:* After installing all the requirements we are set to go! Just go run the server with the following command: + ```bash + python manage.py runserver + ``` + +