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

📝 Update readme with information #31

Merged
merged 1 commit into from
Jan 17, 2018
Merged

📝 Update readme with information #31

merged 1 commit into from
Jan 17, 2018

Conversation

dankolbman
Copy link
Contributor

Actual content for the README 🎉

@dankolbman dankolbman self-assigned this Jan 17, 2018

Start a development service of your own:

Copy link
Member

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

Copy link
Member

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

Copy link
Member

@znatty22 znatty22 left a 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

@dankolbman dankolbman added the feature New functionality label Jan 17, 2018
@dankolbman dankolbman requested a review from parimalak January 17, 2018 15:01
@dankolbman dankolbman changed the title 📝 Update readme with information 📝 Update readme with information Jan 17, 2018
Copy link
Member

@znatty22 znatty22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@dankolbman dankolbman merged commit 6b3ae5f into master Jan 17, 2018
@dankolbman dankolbman deleted the readme branch January 17, 2018 20:31
@dankolbman dankolbman mentioned this pull request Apr 2, 2018
alubneuski pushed a commit that referenced this pull request Oct 11, 2024
📝 Update readme with information
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants