NaveFlactem/BlitzBuyr

Table of Contents

• Introduction
• Showcase
• Installation
• Contributing
• Guides
  • Generating/Updating Docs
  • Unit Testing
• Deliverables
• Team
• Conclusion

Introduction

BlitzBuyr is a mobile app designed to revolutionize the online shopping experience by offering users a personalized and interactive platform. With BlitzBuyr, users can discover unique products, compare prices, and connect with a community of like-minded shoppers, creating a vibrant space for individuality and engagement. BlitzBuyr is driven by the need for a more interactive and personalized online shopping experience, aligning with the preferences of users who value short-term, engaging interactions on popular social media platforms. By addressing this gap, we aim to redefine the online marketplace landscape and provide a unique space that highlights the individuality of each product. Beyond this, we aim to create a thriving community where users can connect, share experiences, and build relationships around their shared interests and purchases.

Showcase

Here's a showcase some of the features and user interface of BlitzBuyr:

Installation

Requirements:

• Node.js
• Expo Go app

Steps:

1. Clone the git repository to your local machine.
2. Install the required dependencies by navigating to the project root folder and running the following command: npm install Note: If you are on a Mac/Linux system, you may need to use sudo before the command.
3. Switch to the backend server's folder from the root server by running the following command: cd ./Backend
4. Install the backend server's dependencies and start the server by running the following commands: npm install node server.js
5. Open a new terminal at the project root folder and navigate to the React Native app folder by running the following command: cd ./Frontend
6. Change the serverIp constant at config.js to your own IPv4 address. Make sure to open port 80 to allow the connections used by the app.
7. Start the React Native app by running the following command: npm start
8. On your Expo Go app on your phone, scan the QR code displayed in the terminal to open the app.
9. Use the app as intended.

Contributing

If you want to contribute to the project, follow these steps:

1. Make a fork of the repository for your feature or changes.
2. Create a new branch for your changes.
3. Make the necessary changes and commit them to your branch.
4. Push your branch to your forked repository.
5. Submit a pull request to the main branch of the original repository.

Guides

Generating/Updating Docs

To generate or update the documentation, follow these steps:

1. Make sure you have jsdoc installed globally by running the following command: npm install -g jsdoc
2. Fully delete the Docs folder in the project. This is to generate a fresh documentation folder.
3. At the base project folder (blitzbuyr), run the following command: jsdoc -c jsdoc.json This will generate the documentation based on the JSDoc comments in the code.

To check the generated documentation, simply type localhost in your browser, which will take you to the documentation landing page.

Feel free check the JSDoc main page for more reference and guides on how to use JSDoc.

Unit Testing

Unit testing is done with Mocha and Chai for the backend, and Jest for the frontend. Check their respective test folders in the Backend and Frontend directories. Refer to Frontend Unit Tests and Backend Unit Tests for reference on the existing tests and how to write additional tests.

Deliverables

• Presentation PowerPoint
• Scrum Documents Folder
• Test Plan and Report Document
• Release Summary Document
• Known Issues and Bugs
• Design Documents
• Documentation

Team

BlitzBuyrDevs (BBD)

• Product Owner: Evan Metcalf
• Developers: Lukas Teixeira Döpcke, Alfonso Del Rosario, Thomas Pollicino, Shreyas Vittal

Conclusion

If you have any new or undocumented issues or bugs, submit them in Issues!