Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 2.61 KB

README.md

File metadata and controls

101 lines (63 loc) · 2.61 KB
Raw

Awward-Reviews

Built By Samuel Muriuki

Description

A website that allows your peers to rate your project.

You can view the site at:Heroku

User Stories

These are the behaviours/features that the application implements for use by a user.

  • View posted projects and their details
  • Post a project to be rated/reviewed
  • Rate/ review other users' projects
  • Search for projects
  • View projects overall score
  • View my profile page

Specifications

Behaviour Input Output
Display a list of posted projects On page load Vote and rate on projects

SetUp / Installation Requirements

Prerequisites

  • Python 3.8.10
  • pip
  • virtualenv

Cloning

  • In your terminal:

      $ git clone https://github.com/Samuel-Muriuki/Awward-Reviews/
  $ cd Awward-Reviews

Running the Application

  • Creating the virtual environment

      $ python3.8 -m venv venv
  $ source env/bin/activate

  • Installing Django and other Modules

      $ python3 -m pip install django
  $ python3 -m pip install django_bootstrap
  $ python3 -m pip install psycopg2

Testing the Application

  • To run the tests for the class files:

      $ python3 manage.py tests

Technologies Used

  • Python 3.8.10
  • Django 4.0.3
  • Pillow 9.0.1

License

MIT License

Copyright (c) [2022] [Samuel-Muriuki]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Go Back to the top

Author Bio

Slack Profile - Samuel-Muriuki

Go Back to the top