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

Convert to REST APIs. #22

Open
akshatvg opened this issue Sep 20, 2020 · 9 comments
Open

Convert to REST APIs. #22

akshatvg opened this issue Sep 20, 2020 · 9 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature_request good first issue Good for newcomers hacktoberfest

Comments

@akshatvg
Copy link
Member

The current code uses Django templating. Try converting the project into REST APIs with proper documentation.

Brownie points if you can link the APIs too.

@akshatvg akshatvg added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers feature_request hacktoberfest labels Sep 20, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.86. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@fisher60
Copy link

fisher60 commented Sep 26, 2020

Hello, I would be interested in taking on this issue for Hacktoberfest. I would appreciate being assigned if this is ok with you. Thank you!

I would also need more info about what needs to be included in the REST api.

@akshatvg
Copy link
Member Author

@fisher60 sure.

You can go ahead and start working on it.

Please note: Incase of no activity for a long time, the project will be assigned to someone else.

@raysandeep will be briefing you here what all are needed for the REST API.

@fisher60
Copy link

Alright, sounds good. I would appreciate the brief whenever possible. Thank you.

@raysandeep
Copy link
Contributor

Hey @fisher60,
I'm so glad you're interested in this project. So, currently, the whole code uses Standard Jinja Templating. For changing this to Rest APIs. You mainly need to make 4 routes I suppose.

  • POST File and Get the Output.
  • GET All previous Submission Records.
  • Login
  • Sign up

For the first one, the algo will be available in the dashboard route handler you can use that. Pass on the location f file it will give you the output for the same.

For the second one, you need to basically flush out all the values in DB by filtering out with user id.

Remember to make these both routes you need to have some Rest API authentication. I would recommend you to use Token Auth. Check out this library Djoser.

Feel free to reply in this thread if you're stuck. I would love to help you out. ✌

@fisher60
Copy link

I will need help setting up this project. I am getting errors when installing the requirements to virtualenv. The readme instructions say to use global installs, but I am not going to do that.

@akshatvg
Copy link
Member Author

akshatvg commented Oct 1, 2020

@fisher60 I think it is more of a Python or Ubuntu problem you may be facing with virtualenv not having the right path. Could you please confirm if nothing in here helps you?

@fisher60
Copy link

fisher60 commented Oct 2, 2020

image
The instructions here appear to say to install globally, then activate some script that is not included with the repo.

@akshatvg
Copy link
Member Author

akshatvg commented Oct 2, 2020

@fisher60 that’s a typo. Good catch. Scripts are in the env folder.

You can correct this in your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature_request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants