TypeScript

NextJS

PostgreSQL

Docker

Project Background

The Lab.ms is a non-profit makerspace in Plano, Texas with a mission to foster development in the disciplines of art, science, technology, and engineering. The Lab boasts over 150 members and an all-volunteer leadership team.

In Fall 2024, I worked with a small group of developers to rework a prior implementation of the web application under the organization, Engineering Projects in Community Service, which connects undergraduate engineering students with real-world projects for local non-profits

Problems

• No Documentation

• Non-functional local database

• No or Minimal Error Handling

• Unresponsive User-Interface, which did not even work on Target Device

• Unimplemented RSVP System

• Spagheti Code

Solutions

• Create a wiki for project documentation

• Replace faulty local database with custom dummy APIs and API endpoints to connect to project partner's database upon integration

• Implement error handling

• Make user-interface responsive to most devices, with emphasis on target device

• Implement RSVP System (with RFID scan-in system)

• Refactor entire codebase to adhere to conventional coding standards

Challenges

During development, we experienced numerous hangups including not being able to access the codebase, a project partner with minimal knowledge of software requirements and portions of the codebase locked behind permissions set by a prior developer. These challenges impeded our progress as late as our first planned sprint. However, through productive communication, we were able to navigate around these problems before the end of our first sprint.

Result

Despite challenges, we were able to deliver a project The Lab.ms was sufficiently satisfied with. We had met all of our acceptance criteria, and we were able to sufficiently refactor the codebase and provide documentation for the next group of developers.

Takeaway

Prior to this project, I had not realized the agony that is dealing with a prior developer's mess. This project made me realize the importance of delivering well thought-out code that could be built upon. While the prior solution worked (more or less), it did not lend itself to the principles of maintainability. Going forward, I aim to heavily consider the maintainability and readability of each of my commits.