Rib Reviews

Serverless Next.js backend + Flutter mobile app that allows users to rate their favourite restaurants.
Explore the docs »

View Live Version · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Because we frequently visited grill restaurants with a group of colleagues to compare their spareribs, we started The Eat Guild. This app makes it possible for all members to review these restaurants. It also acts as a suggestion pipeline, so it's easier to track where we want to go next.

Rib reviews is a Flutter mobile app backed by a Serverless Next.js backend hosted on Vercel. It uses MongoDB Atlas as a database and Firebase for authentication. The app is also integrated with Slack using a bolt-js slackbot. The slackbot allows users to suggest new restaurants and plan events.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This project is set up in three main folders. The frontend folder contains the Flutter mobile app, the backend folder contains the Next.js backend and the slackbot folder contains the bolt-js slackbot. They all contain their own respective setup instructions.

• Click here to read more about the technical setup of the mobile app.
• Click here to read more about the technical setup of the backend.
• Click here to read more about the technical setup of the slackbot.

(back to top)

Roadmap

• Plan events
• Rate restaurants
• React on restaurant ratings using emoji's
• Slackbot to suggest new restaurants
• Vote for suggested restaurants
• Plan events using Slackbot
• Notify users about upcoming events

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the GPLv3 License. See LICENSE for more information.

(back to top)

Contact

Jordy van Vorselen - @jordyvanvorselen - jordyvanvorselen@gmail.com

Project Link: https://github.com/jordyvanvorselen/rib-reviews

(back to top)