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

Example site #10

Open
stuartcampbell opened this issue Feb 9, 2021 · 4 comments
Open

Example site #10

stuartcampbell opened this issue Feb 9, 2021 · 4 comments

Comments

@stuartcampbell
Copy link

It would be nice to be able to either see an example instance running (I see you link off to https://iffsamples.fz-juelich.de/instruments for example, but this isn't accessible to someone looking to test SampleDB.) or maybe give the option to populate with some test data.

I found myself with a few times with an entry form and not sure what information would be useful to put in the boxes. This is where a populated example could really help.

@FlorianRhiem
Copy link
Member

Hey @stuartcampbell,

thanks for the suggestion, currently demo.py is used to try out and demo features and changes in a prepopulated development environment, though the data there is parts realistic, parts for trying specific features only. It should be possible to set up something similar to that online with more realistic data, though I will have to see about how users will be able to sign in, making sure no emails are sent out, that the data is correctly reset periodically etc.

Probably the best route would be to first allow some way to setup a "demo" instance with the docker image, and then making it safe as an openly usable online demo next. I cannot promise that an online demo like this will be available soon, but it definitely sounds like something useful to showcase SampleDB and to provide some more assistance for new SampleDB admins.

@stuartcampbell
Copy link
Author

stuartcampbell commented Feb 12, 2021

I think something like a demo docker container, even if its a separate image that is run just to showcase what SampleDB can do would be great.

Thank you for considering the suggestion.

@FlorianRhiem
Copy link
Member

True, something like demo.py for the docker image doesn't have the all the risks of an open demo on the web attached to it, so it should be much easier to achieve. I'll try and set up something like that next week. Thanks!

@FlorianRhiem
Copy link
Member

There's now a new script for setting up demo data in the development version. After starting the sampledb container, it can be e.g. be called like this: docker exec sampledb env/bin/python -m sampledb set_up_demo

Once the next release is out (when this script is therefore included in the release Docker image), I will add that step to the guide as an optional command for setting up the demo data.

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

No branches or pull requests

2 participants