Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Conversation

@trulyronak
Copy link

Hello to the team at Hack4Impact! I was really inspired by the work your team has been doing, and I was especially impressed at how your team is solving real world problems, and I noticed that your team built this incredible flask boilerplate that empowers everyone to create a impact.

I've been contributing to the Optic Project and helped write integration guides on how you can use it on various API frameworks in the past, and wanted to go a step further by PR-ing my work into awesome boilerplates. Using the boilerplate, I wanted to add a way for the documentation to update as I modified it, so I added Optic. Finding it helpful, I thought it'd be really useful to contribute back and add auto docs to the project.

Did I implement this correctly?

Key Changes

  • Modified manage.py to look for the OPTIC_API_PORT (this enables optic to run) - this won't stop you from running the api like normal via honcho)
  • Created initial documentation for the app (you can see what I've built so far by doing api spec)
  • Updated README to explain how to see and update the documentation
@abhisuri97
Copy link
Contributor

I'm going to lean towards not merging in, @Others at h4i, feel free to reopen if you feel that it's beneficial. Current concern is that its another thing to maintain and doesn't apply to us since we don't have API routes really.

@abhisuri97 abhisuri97 closed this Jan 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

2 participants