Feedback

.github/ISSUE_TEMPLATE/spike-template.md

@@ -1,17 +1,9 @@
 ---
 name: Spike Template
 about: A template to use for Spikes
-title: ''
+title: ""
 labels: spike
-assignees: ''
-
+assignees: ""
 ---
 
-## Estimation of work
-- TBD
-
-## Acceptance criteria
-- [ ] foo
-- [ ] bar
-- [ ] etc
-- [ ] etc
+_By definition, this `spike` is not related to any specific User Story._

.github/ISSUE_TEMPLATE/task-template.md

@@ -1,10 +1,11 @@
 ---
 name: Task Template
 about: A template to use for Tasks
-title: ''
+title: ""
 labels: task
-assignees: ''
-
+assignees: ""
 ---
 
 Related to User Story #?
+
+_By definition, this `task` represents one unit of work that is part of the implementation of a single user story._

.github/ISSUE_TEMPLATE/user-story-template.md

@@ -1,16 +1,17 @@
 ---
 name: User Story Template
 about: A template to use for User Stories
-title: ''
+title: ""
 labels: user story
-assignees: ''
-
+assignees: ""
 ---
 
-## Estimation of work
+## Estimation of effort (optional)
+
 - TBD
 
-## Acceptance criteria
+## Acceptance criteria (optional)
+
 - [ ] foo
 - [ ] bar
 - [ ] baz

.github/workflows/ci-cd.yml

@@ -0,0 +1,39 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ anasofia2 ]
+  pull_request:
+    branches: [ anasofia2 ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x] 
+
+    env:
+        EXPRESS_APP_MAP_API_KEY: ${{ secrets.EXPRESS_APP_MAP_API_KEY }}
+        FRONT_END_DOMAIN: ${{ secrets.FRONT_END_DOMAIN }}
+        GOOGLE_SHEETS_APIKEY: ${{ secrets.GOOGLE_SHEETS_APIKEY }}
+        MONGODB_URI: ${{ secrets.MONGODB_URI }}
+        REACT_APP_BACKEND: ${{ secrets.REACT_APP_BACKEND }}
+        REACT_APP_MAP_API_KEY: ${{ secrets.REACT_APP_MAP_API_KEY }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install Dependencies
+      run: npm run install-dependencies
+
+    - name: Run Tests
+      run: |
+        cd back-end
+        npm test
+

.github/workflows/event-logger.yml

@@ -0,0 +1,58 @@
+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

@@ -39,6 +39,9 @@ Thumbs.db
 # Typical Node.js artifacts #
 #############################
 
+# Lock file so we don't bloat the git log stats
+package-lock.json
+
 # Logs
 logs
 *.log
@@ -113,6 +116,7 @@ typings/
 
 # dotenv environment variables file
 .env
+back-end/credentials.json
 
 # next.js build output
 .next

CONTRIBUTING.md

@@ -1,2 +1,37 @@
-# 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)
+# Contributing to NYU Shuttle
+
+Thank you for your interest in contributing to our project. We welcome your contributions and value your input.
+
+## Git Workflow
+
+We follow a Git workflow to manage our codebase. The primary branches are:
+
+- `main`: The main development branch.
+- `feature/*`: Feature branches for developing new features.
+- `bugfix/*`: Bugfix branches for addressing issues.
+
+## Rules of Contributing
+
+When contributing, please adhere to the following rules:
+- Follow our coding standards 
+- Make sure your contributions align with the project's goals and scope.
+- Respect other contributors
+
+## How to Contribute
+
+To contribute to our project, follow these steps:
+
+1. Fork the repository to your GitHub account.
+2. Clone the forked repository to your local machine.
+3. git checkout -b feature/your-feature-name
+4. git commit -m "Description of your changes"
+5. git push origin feature/your-feature-name
+6. Open a pull request for your changes
+
+## Local Development Environment Setup
+
+1. Clone the repository to your local machine
+2. Install project dependencies
+3. Set up Google Maps API key
+4. Run the development server
+

README.md

@@ -1,19 +1,67 @@
-# Project Repository
+# NYU Shuttle App
 
-This repository will be used for team projects.
+## Project Description
 
-Several sets of instructions are included in this repository. They should each be treated as separate assignments with their own due dates and sets of requirements.
+The NYU Shuttle App is a mobile application designed to provide real-time information about the NYU shuttle bus service. It is a convenient tool for NYU students, faculty, and staff to track shuttle bus locations, plan routes, and receive updates on shuttle schedules. The primary goal of this project is to enhance the overall commuting experience for the NYU community by making transportation more efficient and accessible.
+
+## Product Vision Statement
+Recognizing the limitations in NYU's existing shuttle app, primarily concerning its user interface, we want to create a better mobile-friendly application with shuttle information that is easy to access and understand. 
+
+## Team Members
+- [r8btx](https://www.github.com/r8btx) 
+- [Jaden Wang](https://github.com/unfiltered-syrup)
+- [Ana Pacheco](https://github.com/anaspacheco)
+
+## History and Contribution Guidelines
+
+The NYU Shuttle App project originated from a group of NYU students who recognized the need for an improved shuttle service experience, as many students and faculty had expressed frustrations with the existing web application. If you'd like to contribute to this project, please read our [CONTRIBUTING.md](CONTRIBUTING.md) document for guidelines on how to get involved.
+
+## Access deployed aplication: 
+
+- Navigate to 138.197.74.172:4000 in your browser to check out our deployed app!
+
+## Building and Testing
+
+Fork the repo and clone it locally. Then:
+
+1. cd to front-end and back-end
+
+2. Install Dependencies:
+   ```bash
+   npm install
+
+3. Put Google Maps API key at utils/MapUtility.js (const API_KEY)
+
+4. In the front end folder, put the following keys in a .env file:
+   - REACT_APP_MAP_API_KEY (please, reach out to us for the exact key)
+   - REACT_APP_BACKEND==http://localhost:4000
+
+5. In the back end folder, put the following keys in a .env file:
+   - MONGODB_URI=  (please, reach out to us for the exact key)
+   - FRONT_END_DOMAIN=http://localhost:3000
+   - EXPRESS_APP_MAP_API_KEY (please, reach out to us for the exact key)
+
+6. To run backend tests cd to the backend folder and run:
+   ```bash 
+   npm test
+
+8. Run frontend and backend 
+   ```bash 
+   npm start
+
+## Additional Resources
+
+- [Initial Prototype](UX-DESIGN.md)
+- [NYU Transportations Routes and Schedules Page](https://www.nyu.edu/life/travel-and-transportation/university-transportation/routes-and-schedules.html)
+- [Current NYU Shuttle Website (PassioGo)](https://nyu.passiogo.com/)
+
+## Contact Us
+
+If you have any questions, feedback, or suggestions, please feel free to open an issue or reach out to any of the core team members mentioned above. We appreciate your support and look forward to improving the NYU shuttle experience together!
 
-1. See the [App Map & Wireframes](instructions-0a-app-map-wireframes.md) and [Prototyping](./instructions-0b-prototyping.md) instructions for the requirements of the initial user experience design of the app.
 
-1. Delete the contents of this file and replace with the contents of a proper README.md, as described in the [project setup instructions](./instructions-0c-project-setup.md)
 
-1. See the [Sprint Planning instructions](instructions-0d-sprint-planning.md) for the requirements of Sprint Planning for each Sprint.
 
-1. See the [Front-End Development instructions](./instructions-1-front-end.md) for the requirements of the initial Front-End Development.
 
-1. See the [Back-End Development instructions](./instructions-2-back-end.md) for the requirements of the initial Back-End Development.
 
-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,9 @@
-# User Experience Design
+# Prototype
 
-This repository contains instructions and files for two assignments that together comprise the user experience design phase of a web app.
+You can access the NYU Shuttle App prototype on Figma:
 
-Replace the contents of this file with the completed assignments, as described in:
+[Figma Prototype](https://www.figma.com/proto/mKJ2EhJmDPv1Rb9mLSi2Tk/NYU-Shuttle-Wireframe-Diagram?type=design&node-id=2-4&t=DLS5tE2C22wTjpjD-1&scaling=scale-down&page-id=0%3A1&starting-point-node-id=2%3A4&mode=design)
 
-- [app map & wireframe instructions](instructions-0a-app-map-wireframes.md).
-- [prototype instructions](instructions-0b-prototyping.md)
+# Site Map
+
+![App Map](sitemap.png)