-
Notifications
You must be signed in to change notification settings - Fork 16
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
[ISSUE 109] Back-end Repo Setup #242
[ISSUE 109] Back-end Repo Setup #242
Conversation
…/test because those are necessary to run the api tests
@@ -22,6 +22,7 @@ downloads/ | |||
eggs/ | |||
.eggs/ | |||
lib/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't feel confident removing this from the .gitignore
so I just included another rule below to include our testing /lib
but let me know!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great to me!
I was able to start the app and access localhost:8080/docs as well as run tests successfully.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, such a major achievement 🎉 👏 !!!
I saw the code quality checks are running, which was the primary ask for this ticket, and I was able to get the API spun up locally (see screenshot below).
Request
My one suggestion, is that we may want to re-evaluate where some of the docs are stored and make it easier for folks to discover the steps needed to install and spin up the API from the main README. But let's create a follow-up ticket for that work to unblock this sizable PR from being merged.
Summary
Fixes #109
Time to review: 1 hour
Changes proposed
This adds a base Flask application with tooling, tests and goodies.
Context for reviewers
Please pull down the branch, run through the
getting-started.md
to check that everything works, and run the tests!Fast follow issues:
Pre-commit hooks #223
Vulnerability checks #239
License checks #238
Note: After this PR is on main, will need someone with admin privileges to add GA checks passing as a blocker for merging PRs.