pitchIdea

A Description of the WebApplication.

Table of Content

• Description
• Behaviour Driven Development
• Installation Requirement
• Technology Used
• Reference
• Licence
• Authors Info
• Live Link

Description

A web application that allows users to pitch an idea. The users will submit their one minute pitches and other users will vote on them and leave comments to give their feedback on them.

The pitches are organized by category. .

Behaviour Driven Development

• A user can pick a category/add theirs and be able to pitch an idea on any category they are interested in.
• Can upvote and downvote a comment.

Installation

• Open Terminal ctrl+Alt+T

• Git clone https://github.com/RichieOrito/pitchIdea.git

or

• Git fork - Enter into your own repository and search-https://github.com/RichieOrito/pitchIdea then click on fork to add it on your own repository.

Navigate into the cloned project. cd pitchIdea

Create a start.sh file touch start.sh

Inside start.sh, add the and the SECRET_KEY manage.py command for excuting which starts the server.

• Create the vitual Environment and install the requirements form

---

requirements.txt

---

$ python3 -m venv virtual
$ . virtual/bin/activate
$ pip install -r requirements.txt

export SECRET_KEY=<YOUR_SECRET_KEY>

 python manage.py server`

* `chmod a+x start.sh`

* Run the program
* `$ ./start.sh`

Requirements

• Either a computer,phone,tablet or an Ipad

• An access to the Internet

Go Back to the top

Technology Used

• HTML 5 - which was used to build the structure of the pages.

• CSS - which was used to style the pages incuding the left aside navigation bar.

• Figma-which was used to design the prototype of the UI.

• Python/Flask - Which was used to build the web-applications and interactivity

• postgresql - For the database

Reference

• LMS
• W3schools
• stackOverFlow

Go Back to the top

Licence

MIT License

Copyright (c) 2022 Richard Orito

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

Authors Info

Slack Profile - Richard Omondi

Linked - Richard Orito

Gmail - richard.omondi@student.moringaschool.com

Github - RICHIE ORITO

Live Link

LiveLink- Gh-pages

Go Back to the top