diff --git a/README.md b/README.md index 22c832b1..27298e03 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/gruvw/1009ca75162e4a39e4561300eadbc5c4/raw/proxima_badge.json) + + + # Proxima @@ -6,9 +8,14 @@ Although people get closer through social media, they are physically farther than ever, so we present you Proxima. -Imagine a social app that encourages people to visit interesting places instead of staying at home. +Imagine a social network where every post becomes a destination, encouraging you to step out and explore. +It is not just about scrolling through life, it's about living it, one post at a time. It allows people to share posts, but with a catch: one has to physically move to the place the post was published in order to read it. +Please check out the Product Requirements Document (PRD) for more details about the application: [Proxima PRD](docs/proxima_prd.pdf). + +**Note**: you can also check out the original project proposal: [Proxima Project Proposal](docs/proxima_project_proposal.pdf). + ## Core Functionality - **Split App Model**: Utilizes Google Firebase for storing and retrieving posts and comments, ensuring content is up-to-date and accessible. @@ -16,7 +23,22 @@ It allows people to share posts, but with a catch: one has to physically move to - **Sensor Use**: Integrates GPS tracking to display posts within 100m of the user's current location, making content relevant and localized. - **Offline Mode**: Caches posts for offline access, allowing users to view nearby content without an internet connection. -## User Interface Design +## Application + +Here are a few screenshots of the main screens of the application: + + + + + + + + +**Note**: you can also check out the video presentation of the app: [Proxima Video Presentation](https://www.youtube.com/watch?v=831yjtsBgHM). + +## Technical Details + +### User Interface Design Link to the [Mockup](https://design.penpot.app/#/view/68a1c0e6-b27c-807b-8004-4f1cc693ba89?page-id=76cd5706-e69f-8069-8004-1a1578d3f0c7§ion=interactions&index=40&share-id=ee63301e-1fa7-81b1-8004-5bef8c6bb2fd) (view mode only). @@ -24,9 +46,19 @@ Link to the [Wireframe](https://design.penpot.app/#/view/68a1c0e6-b27c-807b-8004 Link to the [Penpot Project](https://design.penpot.app/#/workspace/43442e9d-d45f-8169-8004-017078780238/68a1c0e6-b27c-807b-8004-4f1cc693ba89). -## Project Architecture Diagram +### Project Architecture Diagram Here is the first architecture diagram of the application for MS1. This should give a quick reference/overview on the overall architecture and the relations between the different screens, data sources, and internal state of the application. Proxima Arichtecture Diagram + +## Contributors + +- Joachim Favre ([@JoachimFavre](https://github.com/JoachimFavre)) +- Lucas Jung ([@gruvw](https://github.com/gruvw)) +- Yoann Lafore ([@yoannLafore](https://github.com/yoannLafore)) +- Camille Lannoye ([@camillelnne](https://github.com/camillelnne)) +- Alberts Reisons ([@Aderfish](https://github.com/Aderfish)) +- Quentin Sandoz ([@TheTexanCodeur](https://github.com/TheTexanCodeur)) +- Guillaume Vitalis ([@CHOOSEIT](https://github.com/CHOOSEIT)) diff --git a/docs/proxima_prd.pdf b/docs/proxima_prd.pdf new file mode 100644 index 00000000..5b72f7e1 Binary files /dev/null and b/docs/proxima_prd.pdf differ diff --git a/docs/proxima_project_proposal.pdf b/docs/proxima_project_proposal.pdf new file mode 100644 index 00000000..ab92b071 Binary files /dev/null and b/docs/proxima_project_proposal.pdf differ diff --git a/docs/screenshots/challenges.png b/docs/screenshots/challenges.png new file mode 100644 index 00000000..a68a2a8c Binary files /dev/null and b/docs/screenshots/challenges.png differ diff --git a/docs/screenshots/feed.png b/docs/screenshots/feed.png new file mode 100644 index 00000000..25b78ce9 Binary files /dev/null and b/docs/screenshots/feed.png differ diff --git a/docs/screenshots/map.png b/docs/screenshots/map.png new file mode 100644 index 00000000..5ebbe44a Binary files /dev/null and b/docs/screenshots/map.png differ diff --git a/docs/screenshots/post.png b/docs/screenshots/post.png new file mode 100644 index 00000000..08a14a90 Binary files /dev/null and b/docs/screenshots/post.png differ diff --git a/docs/screenshots/profile.png b/docs/screenshots/profile.png new file mode 100644 index 00000000..c4afe2c9 Binary files /dev/null and b/docs/screenshots/profile.png differ diff --git a/docs/screenshots/ranking.png b/docs/screenshots/ranking.png new file mode 100644 index 00000000..ce7c0290 Binary files /dev/null and b/docs/screenshots/ranking.png differ