Skip to content
/ pitched Public

Platform where users submit one minute pitches and other users will vote on them and leave comments to give their feedback on them.

License

Notifications You must be signed in to change notification settings

Dhyder/pitched

Repository files navigation

Pug Pitch

Author

Description

Platform where users submit one minute pitches and other users will vote on them and leave comments to give their feedback on them.

Screenshot

cipher

Live Link

You can view the site at: Pug Pitch

User Stories

As a user I would like to:

  • See the pitches other people have posted.
  • Vote on the pitch they liked and give it a downvote or upvote.
  • Be signed in for me to leave a comment
  • Receive a welcoming email once I sign up.
  • View the pitches I have created in my profile page.
  • Comment on the different pitches and leave feedback.
  • Submit a pitch in any category.
  • View different pitch categories.

Specifications

Behaviour Input Output
Load The Page On page load Get all posts, Select between signup and login
Select Sign Up Email,Username,Password Redirect to login
Select Login from a news source Username and Password Redirected to a page with pitches from different categories and commenting section on read button click
Select comment button Comment Form for comment input
To Read more on an entire pitch Click read on pitch Redirected to the pitch viewing page where user can upvote or downvote a pitch

SetUp / Installation Requirements

Prerequisites

  • python3.6.15
  • pip
  • virtualenv

Cloning

  • In your terminal:

      $ git clone https://github.com/Dhyder/pitched.git
      $ cd pitched
    

Running the Application

  • Creating the virtual environment

      $ virtualvenv
      $ source virtual/bin/env
      $ curl https://bootstrap.pypa.io/get-pip.py | python
    
  • Installing Flask and other Modules

      $ python3.8 -m pip install Flask
      $ python3.8 -m pip install Flask-bootstrap
      $ python3.8 -m pip install Flask-Script
    
  • To run the application, in your terminal:

      $ chmod +x start.sh
      $ ./start.sh
    

Testing the Application

  • To run the tests for the class files:

      $ python3.6.15 manage.py tests
    

Technologies Used

  • Python3.8.10
  • Flask

Known Bugs

  • No known bugs at the moment

Author's Contact Information

MIT License:

Copyright (c) 2021 Dhyder 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.

About

Platform where users submit one minute pitches and other users will vote on them and leave comments to give their feedback on them.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published