-
Notifications
You must be signed in to change notification settings - Fork 3
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
📝 Update readme with information #31
Conversation
|
||
Start a development service of your own: | ||
|
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.
Minor change request, can we do something like:
To start a development service of your own:
Clone the git repository via
git clone git@github.com:kids-first/kf-api-dataservice.git
Install dependencies
pip install -r requirements.txt
Set the FLASK_APP environment variable
export FLASK_APP=manage.py
Initialize the database
flask db init
flask db upgrade
Run the service
flask run
|
||
## Testing | ||
|
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.
Following above suggestion, can we do:
Install dependencies
pip install -r dev-requirements.txt
Run tests
flask test
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 good overall, just have a couple minor change requests
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 good!
📝 Update readme with information
Actual content for the README 🎉