Everyone deserves to have an archive of their bug fixes. It's an annoying thing to be faced with a bug you've resolved in the past but you're completely clueless on how you went about the solution. Bugs should not just be fixed but have a story too. This is why we created BugWise!
Bugwise transforms the debugging experience by harnessing the power of voice. It's not just a tool; it's a paradigm shift in how developers approach debugging. Developers can post a voice recording of their bug fixes alongside the bug title and provide some text annotation for context. BugWise empowers developers, from beginners to seasoned professionals, to document their debugging journey through the rich medium of audio.
Now, say goodbye to text-based bug trackers and embrace a more efficient, flexible, and connected bug-fixing experience!
BugWise Audio Journal serves as our Portfolio Project, marking the culmination of our Foundations Year at ALX SE (Holberton) School. Within this initiative, we had the autonomy to select both our collaborative partners and the project we wished to undertake. The sole requirement was the delivery of a functional program by the conclusion of the three-week development period.
Dec 22, 2023 6:00 AM to Jan 26, 2024 6:00 AM
We are two content creation enthusiasts who are passionate about coding but also like to keep it fun!
- Goodness James, Akoma - Technical writer & Chat support agent, Skincare & Beauty guide, and Cat lover but also a very talented Software Developer with a flair for content creation.
- Elizabeth Ginika, Nna - Economist, Content writer, and Customer support specialist, the "fashionista touch" Software Engineer of the team.
Follow us on LinkedIn for tech-related awesomeness!
After the development phase, we each wrote a blog post to reflect on the BugWise journey.
- Goodness' article: BugWise: Just speak your solution.
- Elizabeth's article: BugWise: The paradigm shift in how developers approach debugging.
Take a tour of the deployed version at bugwise
Here is a little preview of our main features:
- Securely create an account using Bugwise's user-friendly registration system.
- Rely on robust Python frameworks for user authentication, ensuring a secure and seamless process.
- Bugwise becomes your coding companion, capturing and storing audio data with JavaScript Web API.
- Articulate your thoughts and debugging process with ease, turning spoken words into a rich tapestry of insights.
- Harmoniously combine spoken explanations with traditional text annotations for a comprehensive debugging diary.
- Seamless integration of HTML and CSS allows developers to complement audio recordings with text annotations.
Some mobile devices are not able to use the recording feature of BugWise even after granting microphone permission.
The text input of bug posts is squished vertically when viewing on mobile.
Our web app is built with the Flask framework, coded mainly in Python. BugWise is back-end heavy, meaning that we focused our time and energy on developing a simple but easy-to-use app. We designed most of the User Interface, using plain CSS and HTML. We also incorporated some Bootstrap elements which offered a nice styling to the web app.
Python - The Backend Language
Javascript - The Media Recorder API
HTML - The Frontend Structure
CSS - The Frontend Styling
Flask - The Web Development Framework
Jinja2 - Templating Engine
SQLAlchemy - Python SQL Toolkit and Object Relational Mapper
SQLite - Database Management System
There are plenty of features that we would love to implement into BugWise in the future and they include:
- Adding a comment feature, sharing a post, and connecting with the post author.
- Include code snippets and attach images to bug posts.
- Activate the sidebar.
- Set post visibility to public or private.
- Include search functionality.
- Implement tags & categorize bug posts.
We welcome contributions! To contribute to BugWise Audio Journal, follow these steps:
- Fork the repository
- Create a new branch (git checkout -b feature/your-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin feature/your-feature)
- Open a Pull Request
ALX SE School - For the help, advice, and resources they provided us with during this project and our curriculum.
Corey Schafer - Our perennial go-to expert for Flask tutorials.
YOU - For reading this documentation and testing out BugWise. We hope you enjoyed the ride!
AirBnB Clone: A simple web app made in Python, Flask, and JQuery.
Simple Shell: A command line interpreter that replicates the Linux shell program.