DataMascara · abrahym-sharfeldden · Aug 15, 2019 · Aug 15, 2019 · Aug 15, 2019 · Aug 15, 2019
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,15 @@
+dist: xenial
+language: python
+sudo: required
+python: "3.7"
+script:
+- python test1.py
+install:
+  - pip install -r requirements.txt
+deploy:
+  provider: heroku
+  api_key:
+    secure: SRQYTCaJ7yYNsVUIG70tF13JW7PQynp9XGwxb7R6neG8R13dsZ1Aip/oyN/4WtpIRBTh9YgH5QO/bqe5MusejDt7j3uGJ9/zAjZj6iY8NVzlglJjHOGWJY9yPLmlqq/vBPIkX9JOdJMHjBDve/fqDSdDUlqOQYRpZq1aCPnKCnhjk2tfux4aWi8kOPayM8tl4mRolTWvrntcgrkenJIQx07GsTO1LwAoum2tlmGiHvbv610xpyIIUIqKNdqv676YdAxKBhQDPjFfORmMMXZswJs2jinrYpnfmwiI0TxU/YiYySjsr6yc/7PVwM/U7Z0Ehz+vuSQDFbR7lGw0XsoEhIkSbg4vKDropClndT7+1rDugc/IfQThkeRlnUGcNTkNkEaTKIgneWLPDx+Oz3mADx5Qp8zfEOXBgk5tRXkAH9M/RStQmeBhvHABmmz33a9GuNZwud6i5J0lhMpI9afNdNznH0f3AN8YKT5WG0/BQMgyXXdVfRVX+nkBff49emDgqbOaygpV0byfv4Ylla3yRdxFsxetrM/HMfCMw6y6wFtkRH07J+PwHAqOhFf0SLTrZ0VQzNKjL8bBQFeHKYd2ZRZozMsnJp9gY/7q2Z72bDg3hdgwyQ/8savJRB0AYbDiOJk8G9TLIOKWPIWhtZiscbaePpG6BUiI7WbrvGyUuXQ=
+  app: bc-app-class
+  on:
+    repo: DataMascara/cisc3140-su19-project
diff --git a/Procfile b/Procfile
@@ -0,0 +1 @@
+web: gunicorn --chdir app app:app
diff --git a/Quality Control/Written Reports of Tests/New Issues (Most Up to Date).pdf b/Quality Control/Written Reports of Tests/New Issues (Most Up to Date).pdf
diff --git a/Quality Control/Written Reports of Tests/Scenario Test Documents/TestScenariosCisc3140 b/Quality Control/Written Reports of Tests/Scenario Test Documents/TestScenariosCisc3140
@@ -0,0 +1,88 @@
+Feature: Automated/manual test
+  Using cisc3140 group app developement
+
+  Background:
+    Given I use dev url to navigate to login page
+
+
+  @Functional  #pass scenario
+  Scenario: Hamburger menu expand for login page
+    Given user navigate to application login page
+    When I am not logged in to the app
+    Then I can see sign in and register button display
+    Then I can see username and password field display
+
+  @Functional    #pass scenario
+  Scenario: Hamburger menu hide for logged in user
+    Given I navigate to application login page
+    When I am not logged in to the app
+    When I type valid <userName> and <password> to login
+    Then menu is in hidden state
+
+@Regression    #pass scenario
+  Scenario Outline: invalid user cannot login to the app
+    Given I navigate to application login page
+    When I type valid <userName> and <password> to login
+    Then error message should display for invalid user
+
+    Examples:
+      | userName         | password         |
+      | ahkdahsj         | jsadhjhdsjjasdja |
+      | 20hdjhadss       | 55651/3^%$,`~*   |
+      | &^.#-?jhadss     | 1545645*sd       |
+      | 20hdjhadss.hhd d | 12k              |
+
+  @Functional   #Failed scenario
+  Scenario: able to like the post
+    Given I login to the app
+    When I click on like button on post
+    Then total like is added next to post
+
+  @Functional  #Failed scenario
+  Scenario: able to dislike the post
+    Given I login to the app
+    When I click on like button on post
+    Then total dislike is added next to post
+
+  @Functional  #Failed scenario
+  Scenario: able to add comments on the post
+    Given I login to the app
+    When I click on comment button on post
+    When I type some comments on the text field
+    Then I can see my comments added to the post
+
+  @Functional  #Failed scenario
+  Scenario: sort the post by hot or new
+    Given I login to the app
+    When I click on sort by dropdown
+    Then I select hot post
+    Then post display for hot
+    Then I select new post
+    Then post is display for new
+
+  @EndToEnd  #Failed scenario
+  Scenario: create a post and view the created post
+    Given I login to the app
+    When I click on create post button
+    And I select communities from dropdown
+    And I type all required field and submit
+    Then I can see my post on my profile
+
+  @EndToEnd  #pass scenario under condition, need to rework, i don't wanna see json output in email
+  Scenario: get notification on email after register
+    Given I login to the app
+    When I register for new user
+    And I type all required fields
+    And I click on register button
+    Then I get an email notification
+
+    @Functional  #pass scenario
+  Scenario: user successfully logout from the application
+    Given I login with valid username and password
+    When I click on logout button
+    Then I see signIn and register button again
+
+
+
+
+
diff --git a/Quality Control/Written Reports of Tests/TestScenariosCisc3140 b/Quality Control/Written Reports of Tests/TestScenariosCisc3140
@@ -0,0 +1,88 @@
+Feature: Automated/manual test
+  Using cisc3140 group app developement
+
+  Background:
+    Given I use dev url to navigate to login page
+
+
+  @Functional  #pass scenario
+  Scenario: Hamburger menu expand for login page
+    Given user navigate to application login page
+    When I am not logged in to the app
+    Then I can see sign in and register button display
+    Then I can see username and password field display
+
+  @Functional    #pass scenario
+  Scenario: Hamburger menu hide for logged in user
+    Given I navigate to application login page
+    When I am not logged in to the app
+    When I type valid <userName> and <password> to login
+    Then menu is in hidden state
+
+@Regression    #pass scenario
+  Scenario Outline: invalid user cannot login to the app
+    Given I navigate to application login page
+    When I type valid <userName> and <password> to login
+    Then error message should display for invalid user
+
+    Examples:
+      | userName         | password         |
+      | ahkdahsj         | jsadhjhdsjjasdja |
+      | 20hdjhadss       | 55651/3^%$,`~*   |
+      | &^.#-?jhadss     | 1545645*sd       |
+      | 20hdjhadss.hhd d | 12k              |
+
+  @Functional   #Failed scenario
+  Scenario: able to like the post
+    Given I login to the app
+    When I click on like button on post
+    Then total like is added next to post
+
+  @Functional  #Failed scenario
+  Scenario: able to dislike the post
+    Given I login to the app
+    When I click on like button on post
+    Then total dislike is added next to post
+
+  @Functional  #Failed scenario
+  Scenario: able to add comments on the post
+    Given I login to the app
+    When I click on comment button on post
+    When I type some comments on the text field
+    Then I can see my comments added to the post
+
+  @Functional  #Failed scenario
+  Scenario: sort the post by hot or new
+    Given I login to the app
+    When I click on sort by dropdown
+    Then I select hot post
+    Then post display for hot
+    Then I select new post
+    Then post is display for new
+
+  @EndToEnd  #Failed scenario
+  Scenario: create a post and view the created post
+    Given I login to the app
+    When I click on create post button
+    And I select communities from dropdown
+    And I type all required field and submit
+    Then I can see my post on my profile
+
+  @EndToEnd  #pass scenario under condition, need to rework, i don't wanna see json output in email
+  Scenario: get notification on email after register
+    Given I login to the app
+    When I register for new user
+    And I type all required fields
+    And I click on register button
+    Then I get an email notification
+
+    @Functional  #pass scenario
+  Scenario: user successfully logout from the application
+    Given I login with valid username and password
+    When I click on logout button
+    Then I see signIn and register button again
+
+
+
+
+
diff --git a/README.md b/README.md
@@ -1,65 +1,57 @@
-# CISC 3140 - Summer 2019 Project
-This is the repository for the group project in CISC 3140 class at Brooklyn College.
+# CISC 3140 - Summer 2019 Project [![Build Status](https://travis-ci.org/DataMascara/cisc3140-su19-project.svg?branch=master)](https://travis-ci.org/DataMascara/cisc3140-su19-project)
+This is the repository for the group project in CISC 3140 Summer Session 2 2019 class at Brooklyn College.
 
 ## UnderDogs
-
 UnderDogs is an information hub for Brooklyn College Computer Science students and faculty. Users can share original content, ask for assistance from other students, find collaborators, and have discussions across an array of curated communities.
 
-## Team-Specific ReadMe
-- [Product Team README](https://github.com/DataMascara/cisc3140-su19-project/blob/master/product/README.md)
-- Backend
-- ect.
-
-# Setup
-
-## Installation
-
-Base-requirements: Python3, Flask Web Framework
-
-## Installing dependencies from the `requirements.txt` file.
-
-- To install dependencies from the `requirements.txt` file. - `pip3 install -r requirements.txt`
-- When new Python libraries are required, update the `requirements.txt` file using the command. - `pip3 freeze > requirements.txt` and push the file to Github. (or `pip` instead of `pip3`
-
-## Running
-
-- **NOTE:** MinimalAPI functionality is currently implemented, with no VIEW/connecting link to the front end.
-- Alpha release will be served on a server soon so that features can be continuously implemented
-- Navigate to the `app/` folder and execute `python main.py` or `python3 main.py` (depending on your setup)
-- Use postman ([https://www.getpostman.com/](https://www.getpostman.com/)) to test the API.
-- Debug user that already exists is :chalshaff12 (it returns their full record) - Currently, the API is just working in some cases and not linked to a view page
-  yet 
-    - Server hosting for live demo is coming soon.
-
-## Try a GET Request
-
-First, make sure you have the API running and you note down the url ie `127.0.0.0:5000`
-
-- Open Postman and go to the header tab and your header Content-Type to "application/json"
-- Go to the "Body" tab and check the "raw" and "JSON(application/json) options under that tab
-- Now put `{"user":"chalshaff12"}` into the raw body (if chalshaff12 exists, so you should get a response that indicates that )
-- Set the request to GET and the URL `http://YOURLOCALHOSTURL:5000/user` 
-  - TADA! You should see a json response with that user's information in the response body below with a status of 200!
-  - Currently looks like this, but will be cleaned up for easy data getting. 
-``` 
-{
-  "users": [
-    {
-      "avatarUrl": null,
-      "dateCreated": "2019-07-25 23:46:14",
-      "dateModified": null,
-      "email": "[email protected]",
-      "first": "Michal",
-      "isActive": 1,
-      "last": "Shaffer",
-      "password": "hashedpassword",
-      "userid": 246815,
-      "username": "chalshaff12"
-    }
-  ]
-}
-```
-
-### Test on a user that doesn't exist
-
-- Follow the above steps but put `{"user":"notrealuser13"}` into the raw body (notrealuser13 does NOT exist, so you should get a response that indicates that) - TADA! You should see `{"error": "User Not found!"}` in the response body below with a status of 404!
+## Alpha Site : [https://bc-app-class.herokuapp.com/](https://bc-app-class.herokuapp.com/)
+## Launch Form/Feedback : [https://forms.gle/DWKj28iPHTBTwDvK8](https://forms.gle/DWKj28iPHTBTwDvK8)
+## Setup
+### Installation
+- [Python3](https://www.python.org/downloads/) 
+- Flask Web Framework (`pip3 install flask`)
+
+### Requirements
+- To install dependencies from the `requirements.txt` file: 
+```pip3 install -r requirements.txt```
+- When new Python libraries are required, update the `requirements.txt` file using the command and push the file to Github.
+```pip3 freeze > requirements.txt```
+
+## Deployment
+### Running
+***NOTE:** API connectivity is implemented. Please be careful when editting files as some files are necessary in order to keep the connection running.*
+
+- Alpha release will be served on a server soon so that features can be continuously implemented.
+- Navigate to the `/app` folder and execute `python3 app.py`
+
+## Usage
+### Notes 
+- Make sure that the dependencies are up to date.
+- Make sure that UnderDogs website is running in your web browser.
+
+### Registration
+*Alternatively, you can fast track to the [**Signing In**](#Login) section*
+
+- Open the tab on the left side of the browser
+- Select the `Register` button
+- Enter your registration details into the fields.
+
+### Login
+First, make sure you have the API running and you note down the url ie `localhost:8080`
+
+- Open the tab on the left and enter the following information into the fields:
+- Username: `username`
+- Password: `password`
+
+## Contributing
+### Before Pushing
+- Please run `git fetch` in order to update your current working branch with any recent commits pushed to the repo. This will help minimize the frequency at which your old code from another file overwrites the code that was recently updated in that file.
+
+### Suggested Flow
+The following method, known as Git Workflow, is ideally the way we should be approaching updates to the repo:
+- When you are working on a new feature or issue or anything, create a new branch with: ` git checkout -b <branch-name>`. Essentially, the branch name tends to be a short but descriptive name of the task being done in that branch. 
+- When you are finished with your code, commit and push your branch to the repo using: ```git commit -am "<commit-message>"
+git push origin <branch-name>```
+- Lastly, create a pull request from your branch to the master branch, then the update is discussed and then merged through the pull request.
+
+This method of updating the app, known as the Git Workflow, decreases the oppourtunity for old code to rewrite new code.