Skip to content

Commit

Permalink
docs(readme): first version of polished readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gruvw committed May 29, 2024
1 parent ef14a13 commit 4e3a89f
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 4 deletions.
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,64 @@
![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/gruvw/1009ca75162e4a39e4561300eadbc5c4/raw/proxima_badge.json)
<img src="assets/images/proxima_white.png" width="100" align="right">

<a href="https://github.com/ProximaEPFL/proxima/releases/download/v0.4.1/Proxima-v0.4.1.apk"><img src="https://img.shields.io/badge/download_APK-502cb1?style=for-the-badge"></a> <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/gruvw/1009ca75162e4a39e4561300eadbc5c4/raw/proxima_badge.json">

# Proxima

**Discover the world, one post at a time!**

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.
- **User Support**: Requires account creation for posting (Google Sign-In), promoting a secure and personalized user experience.
- **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:

<img src="docs/screenshots/feed.png" height="400">
<img src="docs/screenshots/post.png" height="400">
<img src="docs/screenshots/map.png" height="400">
<img src="docs/screenshots/challenges.png" height="400">
<img src="docs/screenshots/ranking.png" height="400">
<img src="docs/screenshots/profile.png" height="400">

**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&section=interactions&index=40&share-id=ee63301e-1fa7-81b1-8004-5bef8c6bb2fd) (view mode only).

Link to the [Wireframe](https://design.penpot.app/#/view/68a1c0e6-b27c-807b-8004-4f1cc693ba89?page-id=93d0ad32-dfe5-8194-8004-0171998eeabf&section=interactions&index=20&share-id=ee63301e-1fa7-81b1-8004-5bef2dc7d349) (view mode only).

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.

<img src="https://github.com/ProximaEPFL/proxima/assets/53620532/a895c3e9-5c80-4c1b-bd87-decf1b1ddaea" alt="Proxima Arichtecture Diagram" width="600">

## 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))
Binary file added docs/proxima_prd.pdf
Binary file not shown.
Binary file added docs/proxima_project_proposal.pdf
Binary file not shown.
Binary file added docs/screenshots/challenges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/post.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/ranking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4e3a89f

Please sign in to comment.