CSE 110 Group 9 - Powellmon

Bujo Studio

Our bullet journal app, Bujo Studio, can be accessed here.

Final project videos

• Final public video
• Final private video

Setup

To set up a local copy of this repo, follow these steps:

1. Clone this repo to your local machine
2. Install Node.js and npm
3. In your local copy, run npm install to install the dev dependencies and set up the pre-commit hook for the linter

CI/CD pipeline/Documentation

• All information about our CI/CD pipeline can be found in admin/cpipeline
• The status of our latest pipeline can be found here
• Demo video for our pipeline
• JsDocs can be found in docs/ and can be viewed here

Group materials

The admin directory contains all the group artifacts for this project:

• meetings - contains all our group meeting notes
• misc - contains signed team contracts
• videos - contains team videos
• Sprint materials:
  • Sprint 1:
    • Review meeting notes
    • Retrospective
  • Sprint 2:
    • Review meeting notes
    • Retrospective

Design documents

The specs directory contains all the design documents for our app:

• adrs - contains the architecture design records(ADRs) for this project
• brainstorming - contains brainstorming artifacts
• interface - contains wireframes, diagrams, app screenshots for this project
• Project pitch - initial pitch document describing initial app, risks, rabbit holes, etc.
• user profiles - contains the user profiles that inspired our app

Source code

The source directory contains the source code for our app. It is broken up into the following folders:

• frontend - contains frontend pages for app_
  • app - pages for our app, each page has its own folder containing HTML/CSS/JS related to that page
  • assets - images for our app
• backend - contains backend API/functions for managing CRUD operations
• deprecated - contains files for pages/features that were scrapped/didn't get completed

Testing

The test directory contains the test files for the automated unit and manual end-to-end tests. It is broken up into these folders:

• dev - contains developer-generated Jest unit tests (basic function returns)
• tester - contains tester-generated Jest unit tests (DOM manipulation)
• integration - contains Jest integration tests (Frontend DOM with backend)
• e2e - contains manual Jest puppeteer end to end tests (user flows)
• The latest coverage report for our automated tests can be found here
• Reports for end-to-end/manual tests are stored in admin/test-reports.