Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add REST API example with plumber #260

Merged
merged 6 commits into from
Aug 2, 2024
Merged

Add REST API example with plumber #260

merged 6 commits into from
Aug 2, 2024

Conversation

ellieko
Copy link
Contributor

@ellieko ellieko commented Jul 30, 2024

Added example code in examples/plumber/ for writing a RESTful API using Plumber and deploying it on Ploomber Cloud

examples/plumber/

  • Dockerfile
  • main.R
  • plot.png
  • rest_controller.R

The detailed explanation is written in ploomber.io.


📚 Documentation preview 📚: https://ploomber-doc--260.org.readthedocs.build/en/260/

@neelasha23
Copy link
Contributor

neelasha23 commented Jul 30, 2024

@ellieko Please deploy the app to prod and share the app link here. Also , add a README.md file and describe the project, steps for testing locally. Steps for deploying to cloud. And link relevant documentations

Copy link
Contributor

@bryannho bryannho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neelasha23 it's currently available here: https://white-rice-0081.ploomberapp.io/__docs__/#/
but @ellieko let us know if that changes

Tested the API and it looks good, but will test again once the changes are made that we requested in the blog PR.

Refer to the other demo app readme.md for tips on formatting, the main thing is the title and description should look like:

# Title

Description

Any other instructions

* Add another linear model that takes multiple parameters

* Divide the dataset into train set and test set

* Edit plotting function to display actual vs. predicted length
@neelasha23
Copy link
Contributor

have u deployed a new app with he updated model? @ellieko

@ellieko
Copy link
Contributor Author

ellieko commented Aug 1, 2024

@neelasha23 yes! I just deployed it here: https://dry-queen-2196.ploomberapp.io/__docs__/
I'm working on the README.md file, and will push the updates soon!

@ellieko
Copy link
Contributor Author

ellieko commented Aug 1, 2024

@neelasha23 @bryannho
I've updated the demo and it's now live at https://dry-queen-2196.ploomberapp.io/__docs__/. I've also added README.md which is a simplified version of the blog post. Please take a look and share your thoughts!

Copy link
Contributor

@bryannho bryannho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, awaiting review from @neelasha23

Copy link
Contributor

@neelasha23 neelasha23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@neelasha23 neelasha23 merged commit 593fdf4 into main Aug 2, 2024
1 check passed
@neelasha23 neelasha23 deleted the restapi-plumber branch August 2, 2024 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants