Skip to content

This a web application that allows a user to create pitches and view them category wise

License

Notifications You must be signed in to change notification settings

brayokenya/Scribble

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maintainability

Scribbles

Scribbles is an application that allows users to create one minute pitches. The users will submit their one minute pitches and other users will vote on them and leave comments to give their feedback on them.

Author

Brian Kiiru Kimani

Installations

The following command installs all the application requirements

pip freeze -r requirements.txt

Setup

Run https://github.com/brayokenya/Scribble.git

or download the zip file from github.

After extracting the files,

  1. Navigate to the project folder

cd name_of_folder

  1. Creating a virtual environment

virtualenv virtual.

  1. Activating the virtual environment

source virtual/bin/activate.

  1. Running the application

python3 manage.py server

  1. Running tests

python3 manage.py test.

Technologies used

  • Python3
  • Flask
  • Javascript
  • Html5
  • Css3
  • Bootstrap4

User Stories

  • As a user, I would like to see the pitches other people have posted.
  • As a user, I would like to vote on the pitch they liked and give it a downvote or upvote.
  • As a user, I would like to be signed in for me to leave a comment
  • As a user, I would like to receive a welcoming email once I sign up.
  • As a user, I would like to view the pitches I have created in my profile page.
  • As a user, I would like to comment on the different pitches and leave feedback.
  • As a user, I would like to submit a pitch in any category.
  • As a user, I would like to view the different categories.

BDD(Behaviour Driven Development)

Login Inputs

Inputs Description
Username Account username, eg johndoe
Password Account password, eg parseword

Signup inputs

Inputs Description
Username Account username, eg johndoe
Email User email, eg morty@testmail.com
Password Account password, eg parseword
Confirm Password Account password, eg parseword

Pitches inputs

Inputs Description
Heading Pitch description eg; pickup lines
Pitch text The actual pitch body
Comment A comment on the pitch

Fun Fact

I broke a sweat

MIT License © 2020 Brian Kiiru

Collaborate

To collaborate, reach me on kiirubrian21@gmail.com