BBTV - Meal Nutrition API - Team GoCanada

Inspiration

Create a network of friends to share knowledge, learn new technologies and take at least one of us to Canada, so he can take us all!!!

What it does

It enables the API consumer to create recipes with ingredients and see the nutritional information. It also allows searching for recipes within a range of calories (energy)

How we built it

We built the REST API using the LTS version of Laravel (5.1 LTS). We defined the required endpoints for the backend and split them among the team members. We don't live near each other, so we used google docs to brainstorm and to write the documentation, skype to communicate and bitbucket/git to version the code.

Challenges we ran into

We took some time to define the initial project architecture and we believe that a little bit more time to plan the whole project would be good.

Accomplishments that we're proud of

We are proud of the group's dynamics and that we were all able to discuss ideas and extract the best of them without running into any divergences. We built a nice API and we were able to learn a lot.

What we learned

Well... We all worked together in all the steps of the project: planning, definitions, implementing and testing... This hackathon was good to learn from our teammates' experience, since all of us work with PHP since the last decade and we came from PHP 4. We improved our skills of team work and remote job collaboration and our knowledge of PHP Unit and REST.

What's next for BBTV - Meal Nutrition API - Team GoCanada

User authentication and third party login integration (Facebook, etc…)
Tags
Cache
Pagination
HTTP 429 (Too Many Request) Middleware

Built With

Submitted to

VanHackathon

Created by

In a team where all the members are senior PHP developers, you can only bring your personal experiences, share them and put them to discussion.

I, as the rest of the team, contributed with ideas for the solutions.

We always had more than one option on how to approach a subject, so we discussed the pros and cons until we reached something we thought that would please you.

We divided the implementation of the code in a equal way and we helped each other via skype whenever someone had doubts.

I wrote parts of the validation, store and update, tests and repos and I was able to learn a lot, mainly on the PHP Unit subject, since I'd never worked with it previously and my knowledge was only on "academic basis".

Plínio Oliveira
This was my first hackaton, despite the fact that I have been working with IT for over 10 years. I really enjoyed the dynamics of doing this hackaton from the planning to the implementation, everything went really well.

Working remotely with highly motivated and skilled friends was a really good approach.

I could contribute with up to date development practices like SOLID, testing, Agile and Laravel architecture and also API planning as long as with the scope and non-scope definition of the MVP.

It was by all means a great experience. Good to play with friends!

Mathias Grimm
First thing the team agreed was that this opportunity should be handled with care and joyfully.

So all the team designed and planned the API through constant debating and sharing opinions with pros and cons. After the solutions where presented, based on the project limits and scope, the decisions were made and the implementation began.

Personally, I worked with Routes, Composer integrations, Recipe Controller, Recipe Model, Recipe Repository integration with Repository Package prettus/l5-repository, API integration using Guzzle package, and Controller Testing with PHPUnit and of course git. Also did code documentation,which was reviewed and improved afterwards.

The whole experience was very positive and exciting and I'm looking forward to work with BroadbandTV.

Marcos Grimm
Initially we defined concepts and structures, then we contributed with ideas to the project and we worked together to decide the best approach!
I worked with composer, git, migrations, PHP Unit tests and bank transparency - by preparing the system to work with both MySQL and SQLite, since initially we decided to use only MySQL.
I was very happy because we worked remotely with success!

Eduardo Colombo

Updates

Mathias Grimm posted an update — May 25, 2016 09:39 AM EDT

This was my first hackaton, despite the fact that I have been working with IT for over 10 years. I really enjoyed the dynamics of doing this hackaton from the planning to the implementation, everything went really well.

Working remotely with highly motivated and skilled friends was a really good approach.

I could contribute with up to date development practices like SOLID, testing, Agile and Laravel architecture and also API planning as long as with the scope and non-scope definition of the MVP.

It was by all means a great experience. Good to play with friends!

Log in or sign up for Devpost to join the conversation.

Marcos Grimm posted an update — May 23, 2016 01:25 PM EDT

First thing the team agreed was that this opportunity should be handled with care and joyfully.

So all the team designed and planned the API through constant debating and sharing opinions with pros and cons. After the solutions where presented, based on the project limits and scope, the decisions were made and the implementation began.

Personally, I worked with Routes, Composer integrations, Recipe Controller, Recipe Model, Recipe Repository integration with Repository Package prettus/l5-repository, API integration using Guzzle package, and Controller Testing with PHPUnit and of course git. Also did code documentation,which was reviewed and improved afterwards.

The whole experience was very positive and exciting and I'm looking forward to work with BroadbandTV.

Log in or sign up for Devpost to join the conversation.

Plínio Oliveira posted an update — May 23, 2016 09:43 AM EDT

The github like for the project is: https://github.com/batrol/vanhackathon-meal-nutrition-api/

Log in or sign up for Devpost to join the conversation.

Plínio Oliveira posted an update — May 22, 2016 07:57 PM EDT

You can extract the demo.zip inside the project zip in order to avoid the need of running composer install, migrations, seeders and without configuring the .env. We know that's not a good practice, but we decided to give this option to this project to make your tests easier.

Log in or sign up for Devpost to join the conversation.

Plínio Oliveira started this project — May 22, 2016 06:42 PM EDT

Leave feedback in the comments!

Log in or sign up for Devpost to join the conversation.