From 1cbe51ae1385ac77f1a5cebe800f42cecd80a6e5 Mon Sep 17 00:00:00 2001 From: Deanna Stevens Date: Fri, 9 Feb 2024 22:31:59 -0500 Subject: [PATCH 1/2] Add badges and restructure readme --- README.md | 57 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d4d3f47..a9f8632 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,49 @@
-

PROJECT NAME

+

Belongea's Boulangerie

- +[Visit the bakery](https://laboulangerie.vercel.app/) ## :computer: Tech Stack
+[![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)
## :surfer: Contributors +

+Front End Team: +

[Deanna Stevens](https://github.com/dsstevens) +

+[Bobby Steckline](https://github.com/rsteckline) +

+[John Clay O'Leary](https://github.com/Captainlearyo) +

+Back End Team: +

+[Cory Powell](https://github.com/coryrpow) +

+[Eric Belongea](https://github.com/EricBelongea) ## :book: Context -1 week sprint... +11 day sprint... ## :closed_book: Abstract @@ -31,33 +52,29 @@
-## :pushpin: Planning: +
-:bar_chart: Project Board - +:pushpin: Planning:
- +:bar_chart: Project Boards - -[My project board](project board link) +

+[Our GH Project Board](project board link) +

+[Our Miro Board](miro board link)
-:fireworks:Acceptance Criteria +## :eyes: Preview of App


-
- -## :eyes: Preview of App - -

@@ -79,8 +96,8 @@ To get this app running on your computer: 5. Your web browser should navigate to http://localhost:3000/ ### :space_invader: Challenges -- -- +- Integrating an interactive mapping component with Leaflet +- - ### :dizzy: Wins From 772d1681a2aeb3d796b7d57ca762039879523237 Mon Sep 17 00:00:00 2001 From: Deanna Stevens Date: Sat, 10 Feb 2024 13:10:10 -0500 Subject: [PATCH 2/2] Complete Readme, except for images --- README.md | 66 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index a9f8632..8a3ab63 100644 --- a/README.md +++ b/README.md @@ -22,54 +22,62 @@ ![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)
-## :surfer: Contributors -

-Front End Team: -

-[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.

-[Bobby Steckline](https://github.com/rsteckline) +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.

-[John Clay O'Leary](https://github.com/Captainlearyo) +## :book: Context +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. + + +## :surfer: Contributors :wave: + +### Front End Team: + +[Bobby Steckline](https://www.linkedin.com/in/rsteckline/) | [Github](https://github.com/rsteckline)

-Back End Team: +[Deanna Stevens](https://www.linkedin.com/in/deanna-sofia-stevens/) | [Github](https://github.com/dsstevens)

-[Cory Powell](https://github.com/coryrpow) +[John Clay O'Leary](https://www.linkedin.com/in/john-clay-oleary/) | [Github](https://github.com/Captainlearyo)

-[Eric Belongea](https://github.com/EricBelongea) - -## :book: Context -11 day sprint... +### Back End Team: +[Cory Powell](https://www.linkedin.com/in/coryrpow/) | [Github](https://github.com/coryrpow) +

+[Eric Belongea](https://www.linkedin.com/in/eric-belongea/) | [Github](https://github.com/EricBelongea) -## :closed_book: Abstract - -
line break if needed
-:pushpin: Planning: +### :pushpin: Planning: +
:bar_chart: Project Boards

-[Our GH Project Board](project board link) -

-[Our Miro Board](miro board link) + +[Our GH Project Board](https://github.com/orgs/2308-Bread/projects/1/views/1) + +[Our Miro Board](https://miro.com/app/board/uXjVNzS_wwg=/)
-## :eyes: Preview of App +### :eyes: Preview of App
@@ -89,18 +97,18 @@ Back End Team: ## :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 `. +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 -- -- -- \ No newline at end of file +- 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 \ No newline at end of file