Merge pull request #36 from 2308-Bread/feat/Readme

Feat/readme

README.md

@@ -1,63 +1,88 @@
 <div align="center">
-<h1> PROJECT NAME </h1>
+<h1> Belongea's Boulangerie </h1>
 
-<!-- ![Deployed Site]() -->
+[Visit the bakery](https://laboulangerie.vercel.app/)
 
 ## :computer: Tech Stack <br>
+[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript-125x28.png?v=101)](https://github.com/ellerbrock/typescript-badges/)
+![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
 ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
 ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
-![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
 ![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
 ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
 ![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)
-![Figma](https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white)
-![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
 ![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
 ![Cypress](https://img.shields.io/badge/Cypress-17202C?logo=cypress&logoColor=fff&style=for-the-badge)
+![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)
+![YAML](https://img.shields.io/badge/yaml-%23ffffff.svg?style=for-the-badge&logo=yaml&logoColor=151515)
+![Notion](https://img.shields.io/badge/Notion-%23000000.svg?style=for-the-badge&logo=notion&logoColor=white)
+![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)
+![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)
+![Miro](https://img.shields.io/badge/Miro-F7C922?style=for-the-badge&logo=Miro&logoColor=050036)
+![Github Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white)
+![Heroku](https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white)
+![Ruby on Rails](https://img.shields.io/badge/Ruby_on_Rails-CC0000?style=for-the-badge&logo=ruby-on-rails&logoColor=white)
+![CircleCI](https://img.shields.io/badge/circle%20ci-%23161616.svg?style=for-the-badge&logo=circleci&logoColor=white)
 
 </div>
 
 <div align="center">
-## :surfer: Contributors
-[Deanna Stevens](https://github.com/dsstevens)
 
+
+## :closed_book: Abstract
+
+This project was born out of a love for bread of all kinds. We decided to create an interactive resource connecting a user to breads from across the world. With just a click on a map, a list of breads with cultural information about the tradition of bread-making from that country is displayed, allowing the user to learn more about regional breads. Selecting a bread displays more specific information about that type of bread and also shows a recipe. We wanted to showcase not only the diversity and variety of breads of the world but provide a recipe for the user to adventure into recreating it at home. 
+<br></br>
+We are currently working on Part 1 of the project in which our information is from a handrolled Rails database but in Part 2, we plan to utilize AI to generate a much bigger variety of options for every country in the world. Leveraging AI in this way will allow us to focus on performance and user experience rather than populating a database with information for thousands of breads.
+<br></br>
 ## :book: Context
-1 week sprint...
+This project was created in an 11 day sprint and is currently in v1 stage of the two-part Capstone project. It was designed, engineered and created by a full-stack team in mod 4 at Turing School of Software and Design. 
 
 
-## :closed_book: Abstract
+## :surfer: Contributors :wave:
+
+### Front End Team:
+
+[Bobby Steckline](https://www.linkedin.com/in/rsteckline/) | [Github](https://github.com/rsteckline)
+<br></br>
+[Deanna Stevens](https://www.linkedin.com/in/deanna-sofia-stevens/) | [Github](https://github.com/dsstevens)
+<br></br>
+[John Clay O'Leary](https://www.linkedin.com/in/john-clay-oleary/) | [Github](https://github.com/Captainlearyo)
+<br></br>
+### Back End Team:
+
+[Cory Powell](https://www.linkedin.com/in/coryrpow/) | [Github](https://github.com/coryrpow)
+<br></br>
+[Eric Belongea](https://www.linkedin.com/in/eric-belongea/) | [Github](https://github.com/EricBelongea)
 
-<br>line break if needed</br>
 
 </div>
 
-## :pushpin: Planning:
+
 <details>
 <summary>
-:bar_chart: Project Board
-
+### :pushpin: Planning: 
 </summary>
+
 <div align="center">
-  
+:bar_chart: Project Boards
 <!-- image of project board -->
+<br></br>
+
+[Our GH Project Board](https://github.com/orgs/2308-Bread/projects/1/views/1)
 
-[My project board](project board link)
+[Our Miro Board](https://miro.com/app/board/uXjVNzS_wwg=/)
 
 </details>
 
 <details>
 <summary>
-:fireworks:Acceptance Criteria
+### :eyes: Preview of App
 
 </summary>
 <div align="center">
   <br></br>
 
-<details>
-<summary>
-## :eyes: Preview of App
-
-</summary>
 <!--<img src=[screenshot or gif here] -->
 <br></br>
 <!--<img src=[screenshot or gif here] -->
@@ -72,18 +97,18 @@
 ## :floppy_disk: Installation Instructions
 To get this app running on your computer: 
 
-1. Clone this client repository to your local machine using the command: `git clone <enter github link here>`.
+1. Clone this client repository to your local machine by using the command: `git clone git@github.com:2308-Bread/rails_bread_fe.git` in terminal.
 2. Navigate (`cd`) to your local directory containing the repository
-3. Run `npm install` to install dependencies
-4. Run `npm start` to start the server
+3. Run `npm install` to install node dependencies
+4. Run `npm start` to start the development server
 5. Your web browser should navigate to http://localhost:3000/
 
 ### :space_invader: Challenges 
--
--
--
+- Looking for and then deciding to build our own bread APIs
+- Integrating an interactive mapping component with Leaflet
+- Creating two iterations, the first built for our C# API and this one for our Rails API
 
 ### :dizzy: Wins
--
--
--
+- Utilizing Leaflet mapping with a custom GeoJSON file for our countries
+- Group teamwork made planning, communication, and collaboration very smooth
+- Refactoring this repo for a restructured JSON response after forking off the C# iteration