Welcome to BreakBuddy!

This is the repo for the BreakBuddy API. BreakBuddy is an initiative to help users choose their next holiday destination in an easy and enjoyable way. Our website provides a fun and easy-to-use interface for users all around to world. Our buddy 🐦 will simply ask users a few questions and then recommend the best possible holiday destination that we have in our database. BreakBuddy is a non-profit organisation and our code is completely open-source ❤️.

Copyright Ⓒ 2022 - Hursit Tarcan ®

---

Table of contents

• Our REST API 💻
• How to contribute as a developer 💻
• How to contribute as a translator 📝
• How to contribute to content 💡
• Give us feedback ❓

Our REST API

BreakBuddy is running on a Node.js backend (hosted on Heroku). All our source files are presented in this repository (in the ./src folder). Please visit: https://breakbuddy.herokuapp.com/ for our API documentation. Our API has three endpoints at the moment.

1. Endpoints

Those are the three endpoints that our Node.js API provides:

• GET /

Get request will render our pug.js homepage with all necessary API documentation.  

• POST /game

Post request that accepts a JSON body and responds with a corresponding country. 

• GET /game/:country

Get request will return a PNG image with the given country name. 

How to contribute as a developer

This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️

This part of the readme.md is dedicated to code contributions 💻.

1. Submit an issue

• Create a new issue.
• Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.

2. Fork the repository (repo)

• If you're not sure how, here's how to fork a repo.

If this is your first time forking our repo, this is all you need to do for this step:

$ git clone [email protected]:[your_github_profile]/breakbuddy.git

If you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.

To configure your fork:

$ git remote add upstream https://github.com/breakbuddy/breakbuddy

To sync your fork with the latest changes:

$ git checkout main
$ git fetch upstream
$ git merge upstream/main

3. Make awesome changes!

1. Create new branch for your changes

$ git checkout -b new_branch_name

2. Start developing!

$ Add features, fix bugs, etc... 

3. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword).

$ git commit -m "brief description of changes [fixes #1234]"

4. Push to your GitHub account

$ git push origin

4. Submit your PR

• After your changes are committed to your GitHub fork, submit a pull request (PR) to the main branch of the breakbuddy/breakbuddy repo
• In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
  • ex. updates out of date content [fixes #1234]
• Confirm your preview deploy looks & functions as expected

5. Wait for a review

• Our team will review your PR
• Acceptable PRs will be approved & merged into the main branch

How to contribute as a translator

This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️

This part of the readme.md is dedicated to translation contributions 📝.

1. Submit an issue

• Create a new issue, specify the language that you would like to add.
• Anyone can create a new issue (code contributions are not needed for this).
• Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
• You will be asked to upload a txt file with your translation, this can be done via Discord.

2. Wait for a review

• Our team will review your translation.
• Acceptable translations will be approved & merged into the main branch.

How to contribute to content

This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️

This part of the readme.md is dedicated to content contributions 💡.

1. Submit an issue

• Create a new issue.
• Anyone can create a new issue (code contributions are not needed for this).
• Specify the new feature you would like to add, (design proposal, content change, add new destinations, etc...)
• Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
• Our team will contact you via the issue.

2. Wait for a review

• Our team will review your content change.
• Acceptable content changes will be approved & merged into the main branch.

Give us feedback

This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️

This part of the readme.md is dedicated to feedback contributions ❓.

1. Submit an issue or send us a DM via Discord

• Create a new issue, specify your feedback.
• Anyone can create a new issue (code contributions are not needed for this).
• Our team will contact you via the issue.

2. Wait for a review

• Feedback is greatly appreciated.
• Acceptable changes will be approved & merged into the main branch.
• Thank you for your feedback. ❤️

Copyright Ⓒ 2022 - Hursit Tarcan ®