Feedback

.github/workflows/event-logger.yml

@@ -0,0 +1,59 @@
+# DO NOT TOUCH THIS FILE!!!
+name: log github events
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    types: [opened, closed]
+    branches: [main, master]
+jobs:
+  log:
+    runs-on: ubuntu-latest
+    env:
+      COMMIT_LOG_API: ${{ secrets.COMMIT_LOG_API }}
+      COMMITS: ${{ toJSON(github.event.commits) }}
+      REPOSITORY_URL: ${{ github.repositoryUrl }}
+      EVENT_TYPE: ${{ github.event_name }}
+      EVENT_ACTION: ${{ github.event.action }}
+      EVENT_USERNAME: ${{ github.actor }}
+      EVENT_EMAIL: "${{ github.event.pull_request.sender.email }}"
+      PR_MERGED: ${{ github.event.pull_request.merged }}
+      PR_CREATED_AT: ${{ github.event.pull_request.created_at}}
+      PR_CLOSED_AT: ${{ github.event.pull_request.closed_at}}
+      PR_MERGE_USER: ${{ github.event.pull_request.merged_by.login}}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # this is important so git fetches all history.. the actions/checkout by default fetches all history as one commit which throws off stats
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "^3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --user pipenv
+          pipenv install pytz
+          pipenv install python-dateutil
+          pipenv install build
+          pipenv install requests
+          pipenv install gitcommitlogger
+      - name: Log pull request opened
+        if: github.event_name == 'pull_request' && github.event.action == 'opened'
+        run: |
+          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_opened -d $(echo $PR_CREATED_AT) -un $(echo $EVENT_USERNAME) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+      - name: Log pull request closed and merged
+        if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
+        run: |
+          echo $COMMITS > commits.json
+          cat commits.json # debugging
+          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_merged -d $(echo $PR_CLOSED_AT) -un $(echo $PR_MERGE_USER) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+      - name: Log pull request closed without merge
+        if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == false
+        run: |
+          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_closed -d $(echo $PR_CLOSED_AT) -un $(echo $EVENT_USERNAME) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
+      - name: Log push
+        if: github.event_name == 'push'
+        run: |
+          echo $COMMITS > commits.json
+          cat commits.json # debugging
+          pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t $(echo $EVENT_TYPE) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v

.gitignore

@@ -1,3 +1,8 @@
+# zion's files #
+update_repo.sh
+pm2.config.json
+package.json
+package-lock.json
 # Compiled source #
 ###################
 *.com
@@ -39,6 +44,9 @@ Thumbs.db
 # Typical Node.js artifacts #
 #############################
 
+#ignore lock file to reduce git log stats bloat 
+package-lock.json
+
 # Logs
 logs
 *.log
@@ -123,4 +131,7 @@ typings/
 
 ## Jekyll artifacts
 **/.jekyll-cache
-**/_site/
+**/_site/
+
+## VScode
+.vscode

CONTRIBUTING.md

@@ -1,2 +1,78 @@
-# Guide to Contributing
-Delete the contents of this file and replace with the contents of a proper guide to contributing to this project, as described in the [instructions](./instructions.md)
+# Team norms
+## General team guidelines
+- Join the Discord VC while working to boost productivity and speed up team interactions and communications.
+- When you're stuck, **reach out** to the Scrum Master or team member. There's no harm in not knowing certain things.
+## Sprint cadence
+- Sprint length is 2 weeks
+- Sprint planning meeting should be 1-2 hours in length.
+- Backlog grooming meeting is at least once per sprint.
+- When completing a task, put it in the review section of the board and reference the commit(just paste the commit hash) for the Scrum Master to review.
+## Daily standups
+- Daily standups must be done by the end of the day and submitted to the discord channel by the scrum master.
+- Members must meet in person for 1-5 minutes for the standup meeting.
+- Members that make no progress on a task for more than two standups get reported to management.
+
+# Coding/Contributing guidelines
+## Contributing Guide
+- Never push broken code to main, make sure your code is working and tested. If you do push it, you must fix it immediately as to avoid assigning extra work to other teammates.
+- Rarely push to the main branch, always branch and pull request your finished task to the Github. Only push to main if a change is really minor and wont cause significant merge conflicts.
+- If the pull request is related to a completed task, always put the issue number in the pull request to make it easier for fellow developers to review.
+- People assigned to review the pull request must actually read their code in order to ensure it follows team norms.
+
+## Coding standards
+- Use ES6Lint VS code extension for Javascript.
+- Use Typescript when writing your code to avoid misunderstood data input types.
+- Autoformat your code using `CTRL+SHIFT+I` before committing.  
+- Do not write short variable names whose names dont relate to their function and comment your functions.
+- Write automated tests to cover critical integration points and functionality (once you learn how to do that).
+- Make granular and small commits, per feature or per bug fix.
+- Make short, straight to the point, yet descriptive commit messages.
+
+## Coding standards - CSS
+- Do not use unecessary amount of divs, instead use flexbox/grids when possible for more responsive design.
+- Do not write unresponsive code(that doesn't adapt to size of container).
+- Use variables for colors in CSS to make it easier to go back and edit if necessary.
+### CSS Units
+How to decide which unit to choose(general guidelines):
+- Font-size = em
+- Padding and margin = rem
+- Width = em or %
+
+
+# Project Setup
+
+## Setup the IDE
+1. Install VS code
+2.  Clone the repository using `git clone https://github.com/agiledev-students-spring-2023/final-project-bayt`.
+3.  Open the repo in VS code and download the following extensions:
+    - ESlint
+    - React Snippets
+    - GitGraph
+    - Gitlens
+
+### Build and launch the database
+
+- install and run [docker desktop](https://www.docker.com/get-started)
+- create a [dockerhub](https://hub.docker.com/signup) account
+- run command, `docker run --name mongodb_dockerhub -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=admin -e MONGO_INITDB_ROOT_PASSWORD=secret -d mongo:latest`
+
+The back-end code will integrate with this database. However, it may be occasionally useful interact with the database directly from the command line:
+
+- connect to the database server from the command line: `docker exec -ti mongodb_dockerhub mongosh -u admin -p secret`
+- show the available databases: `show dbs`
+- select the database used by this app: `use example-mern-stack-app`
+- show the documents stored in the `messages` collection: `db.messages.find()` - this will be empty at first, but will later be populated by the app.
+
+If you have trouble running Docker on your computer, use a database hosted on [MongoDB Atlas](https://www.mongodb.com/atlas) instead. Atlas is a "cloud"" MongoDB database service with a free option. Create a database there, and make note of the connection string. In the `.env` file within the `back-end` directory, replace the given `DB_CONNECTION_STRING` value with this one.
+
+### Build and launch the back end
+
+1. Navigate into the `back-end` directory
+1. Run `npm ci` to install all dependencies listed in the `package.json` file.
+1. Run `npm start` to launch the back-end server
+
+### Build and launch the front end
+
+1. Navigate into the `front-end` directory
+1. Run `npm ci` to install all dependencies listed in the `package.json` file.
+1. Run `npm start` to launch the React.js server

README.md

@@ -1,4 +1,39 @@
-# Project Repository
+# Bayt - A shared housing app
+## ~~Website deployed!~~ (Currently Unavaliable)
+Link: `http://www.baytmatesfor.life/`
+
+## Product Vision Statement
+We foresee our **Minimum Viable Product(MVP)** as one that makes the issue of accountability and delegation of responsibility in shared accommodations significantly easier than without the app. The product in essence should solve issues in shared accountability through **quick** generation or writing of tasks required based on rooms in the house. The signup process of the app must be incredibly easy if not non-existent in order to encourage ease of use. Roommates should also be able to at least share and keep track of some form of shared purchases made for the dorm such as furniture and kitchen items. The app should provide more value than the energy needed to use it and set it up to encourage people with busy schedules to use it and see it as a tool that saves time rather than wastes.
+
+## What and why?
+When living in shared accomodations, it becomes difficult to delegate house chores, decide grocery options, and split finances for shares household purchases. Purchases such as that mop you might've bought for everybody to clean the residence or that air fryer you bought and decided to split the payment for. With the IOS app Bayt, you can view who's purchased what, and decide how payment should be handled such as one roommate buying the toilet paper next time or just paying outright cash. You should also be able to generate grocery lists that just make sense, based off meal preferences and dietary restrictions of your roommates. Another important feature is to draft living agreements that arent 200 lines long and straight to the point. In summary, Bayt should make living with people much easier by tackling those common issues across roommates.
+
+## For whom?
+The main users would be students in dormitories, families that work together to take care of their home, or anyone that has shared accomodation. This might also be useful for property managers to manage shared housing when it comes to agreements and disputes.
+
+## How?
+- Payment management
+- Chore scheduling
+- Alerts for tasks
+
+## Who are we? 
+- JoJo Yang: https://github.com/jojo1042
+- Rami Richani: https://github.com/dolf321
+- Diana Yepes: https://github.com/dianaYepes
+- Zander Chen: https://github.com/ccczy-czy
+- Atib Jawad Zion: https://github.com/zion-off
+
+## Setup instructions
+- [Frontend setup](./front-end/README.md)
+- [Backend setup](./back-end/README.md)
+
+PLease note if you are facing any issues connecting to the Backend from the Frontend on **Mac** do the following:
+- Enter the frontend directory.
+- Delete its node_modules folder.
+- Run `npm install`.
+- Then restart your computer.
+
+## Project Repository
 
 This repository will be used for team projects.
 
@@ -17,3 +52,4 @@ Several sets of instructions are included in this repository. They should each b
 1. See the [Database Integration instructions](./instructions-3-database.md) for the requirements of integrating a database into the back-end.
 
 1. See the [Deployment instructions](./instructions-4-deployment.md) for the requirements of deploying an app.
+

UX-DESIGN.md

@@ -1,8 +1,25 @@
-# User Experience Design
 
-This repository contains instructions and files for two assignments that together comprise the user experience design phase of a web app.
+<h1 align="center">Bayt UX Design</h1>
+
+# Prototype
+The Figma prototype link for the Bayt app is <a align="center" href="https://www.figma.com/proto/rs9sNV0nIGotnT7L5qq2jz/Bayt?node-id=178%3A530&scaling=scale-down&page-id=0%3A1&starting-point-node-id=178%3A530&show-proto-sidebar=1">here.</a>
+
+# App Map
+<img src="ux-design/App_Map.png"/>
+<br><br>
+
+# Wireframe Diagrams 
+
+| UX-Wireframe | Description |
+| --- | --- |
+| <img src="ux-design/Login.png"/><br><i>Login Page</i>| This is the initial login page, it prompts for users to enter a username and the house code they belong to login rather than a standard password. For now we assume house codes are assigned to appropriate users and this will be addressed in the future.|
+| <img src="ux-design/Home.png"/><br><i>Home Page</i>| This is the home page in which the user can view all available rooms in the house and add rooms. In the top right you have a profile icon and the footer contains the navigation bar with all the pages. The house name in the header or "Ravenclaw" represents the house name in which the user had been assigned to. |
+| <img src="ux-design/Room_Template.png"/><br><i>Room Template Page</i>| This shows the room and the tasks assigned to the room with a button to take you back to the Home page in which you selected the room. The task bars are buttons that will lead you to the Individual Task Page in which the user can edit/modify tasks. Also the square buttons on the left mark the task as complete or not.|
+| <img src="ux-design/Tasks.png"/><br><i> Tasks Page</i>| This collectively shows all the tasks with the task buttons and the checkmark as stated in the previous description. The filter button allows you to filter task based on criterea such as date or room the task is assigned to, if any at all. The sort button allows you to sort in Chronological order to choose most recently due tasks or not. |
+| <img src="ux-design/Individual_Task_Page.png"/><br><i> Indiviual Task Page</i>| This shows the task details in which you can modify information relating to the task such as the date or time in which it is due to be completed. |
+| <img src="ux-design/Finances.png"/><br><i> Finances Page</i>| This page allows users to communicate and keep track of shared purchases in the living space. |
+| <img src="ux-design/Profile.png"/><br><i> Profile Page</i>| This page allows users to edit their profile details. |
+| <img src="ux-design/Alerts.png"/><br><i> Alerts Page</i>| This is the page to which the user gets notified of near tasks that they are responsible for and the user is led to this page through the footer or through notification.|
+| <img src="ux-design/Settings.png"/><br><i> Settings Page</i>| Allows the user to modify the house details such as name, view whose in their housing group, and log out of their account if needed.|
 
-Replace the contents of this file with the completed assignments, as described in:
 
-- [app map & wireframe instructions](instructions-0a-app-map-wireframes.md).
-- [prototype instructions](instructions-0b-prototyping.md)

back-end/README.md

@@ -0,0 +1,38 @@
+# Backend File Structure
+    .
+    ├── src/                    # Contains the main application code
+    │   ├── controllers/        # Contains controller functions for handling requests
+    │   ├── middleware/         # Contains middleware functions for processing requests and responses
+    │   ├── models/             # Contains data models for interacting with the database
+    │   ├── routes/             # Contains route definitions and handlers
+    │   ├── services/           # Responsible for querying the database
+    │   ├── json/               # Contains json files
+    │   ├── app.js              # Main Express.js application file
+    │   ├── configs/            # Configuration files for the application
+    │   └── validations/        # Backend calls validations
+    │── test/                   # Contains unit tests for the application
+    │   ├── controllers/        # Contains unit tests for controller functions
+    │   ├── middleware/         # Contains unit tests for middleware functions
+    │   ├── models/             # Contains unit tests for data models
+    │   ├── routes/             # Contains unit tests for route handlers
+    │   ├── utils/              # Contains unit tests for utility functions and modules
+    │   └── setup.js            # Setup file for running tests
+    ├── node_modules/           # Contains all installed node modules
+    ├── package.json            # Contains metadata about the project and its dependencies
+    └── README.md               # Contains documentation for the project
+
+# Deploying Instructions
+
+Run `npm install` when in this directory before running any other command.
+
+### `npm start`
+
+Used to initialize the backend with nodemon.
+
+### `npm test`
+
+Used to run the Mocha Unit Tests of the system.
+
+### `npm coverage` 
+
+Used to run the unit tests as well as show code coverage using Istanbul(nyc).

back-end/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "back-end",
+  "version": "1.0.0",
+  "description": "The back-end of your project will live in this directory.",
+  "main": "./src/server.js",
+  "scripts": {
+    "start": "export NODE_ENV=production || set NODE_ENV=production&& nodemon ./src/server.js",
+    "test": "export NODE_ENV=test || set NODE_ENV=test&& npx mocha --recursive",
+    "coverage": "export NODE_ENV=test || set NODE_ENV=test&& npx nyc npm test"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "body-parser": "^1.20.2",
+    "chai": "^4.3.7",
+    "chai-http": "^4.3.0",
+    "cors": "^2.8.5",
+    "dotenv": "^10.0.0",
+    "express": "^4.18.2",
+    "express-validator": "^7.0.0",
+    "istanbul": "^0.4.5",
+    "mongoose": "^7.0.3",
+    "cookie-parser": "^1.4.5",
+    "passport": "^0.5.0",
+    "passport-jwt": "^4.0.0",
+    "bcryptjs": "^2.4.3",
+    "multer": "^1.4.5-lts.1"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "nodemon": "^2.0.21",
+    "nyc": "^15.1.0",
+    "sinon": "^15.0.3",
+    "supertest": "^6.3.3"
+  }
+}