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

[ISSUE 109] Back-end Repo Setup #242

Merged
merged 10 commits into from
Jul 17, 2023

Conversation

daphnegold
Copy link
Contributor

@daphnegold daphnegold commented Jul 14, 2023

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.

@@ -22,6 +22,7 @@ downloads/
eggs/
.eggs/
lib/
Copy link
Contributor Author

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!

@daphnegold daphnegold marked this pull request as ready for review July 14, 2023 20:45
@SammySteiner
Copy link
Contributor

I was able to run tests successfully:
image

Copy link
Contributor

@SammySteiner SammySteiner left a 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.

Copy link
Collaborator

@widal001 widal001 left a 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.

Screenshot 2023-07-14 at 5 08 15 PM

@daphnegold daphnegold merged commit 5467390 into main Jul 17, 2023
@daphnegold daphnegold deleted the daphnegold/sammysteiner/issue-109-back-end-setup branch July 17, 2023 18:25
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.

[Task]: Backend Repo Setup
4 participants