MIBFB-COLLAB/MESSAGE-IN-A-BOTTLE

Message In a Bottle

Find Places That Tell Stories
Explore the docs »

Deploy Link · Report Bug · Request Feature · Project Spec

Table of Contents

1. About The Project
   • Built With
   • Tools Used
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About the Project

Message in a Bottle is an interactive application where users can discover stories about the communities around them. This app was designed as a way to interact with cities, neighborhoods, and the people that inhabit them. The Message in a Bottle Front-end is built with a React framework and designed with a mobile first view so that users can easily navigate the application when out in their community or travelling to a new place.

This application was created in just 2 weeks by a team of 3 front-end and 3 back-end students for our capstone project at Turing School of Software & Design. Creating the Front-End of this full-stack application gave us an opportunity to utilize an Agile workflow to interact and collaborate with a Back-End team.

Built With

• React Micromodal
• Dayjs
• Normalize

Tools Used

• Zoom
• GitHub Organizations
• GitHub Projects
• Miro
• Slack
• Figma for Wireframes

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone git@github.com:MIBFB-COLLAB/MESSAGE-IN-A-BOTTLE.git

2. Install NPM packages

   npm install

USAGE

• A user is able to view the application's home page with a welcome message and press the "Get Stories" button
• The "Get Stories" button navigates the user to a page that display all Message Cards within 50 miles.
• This page's display allows a user to see all of these story's Titles, the time they were created, and the distance the user currently is from the story.
  • On each card, the user is able to click the "Get Directions" button to get up to date directions to find the story's location.
  • On each card, the user is able to click the "View Story" button to View the message's full details if they are within 1/4 mile of the message's location.
    • If the user is out of range of the Message Card, an error will show up telling the user they are not in range and allowing them to navigate back home or to the previous page of cards.
• A user is able to navigate back to the home page from any view in the Application

Mobile Story View Spec	Mobile Create Story Spec

Road Map

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Frontend Team

Fara Akhatova

GitHub
faraakhatova@gmail.com

Mae Duphorne

GitHub
maelduphorne@gmail.com

Justin Anthony

GitHub
justincanthony@gmail.com

Backend Team

Marla Schultz

GitHub
marlaa.schulz@gmail.com

Matt Kragen

GitHub
mattdkragen@gmail.com

Taylor Varoglu

GitHub
taylor.varoglu@colorado.edu