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

Implement a landing page for requests to the base URL #169

Closed
CasperWA opened this issue Feb 6, 2020 · 3 comments · Fixed by #172
Closed

Implement a landing page for requests to the base URL #169

CasperWA opened this issue Feb 6, 2020 · 3 comments · Fixed by #172
Labels
enhancement New feature or request good first issue Good for newcomers priority/low Issue or PR with a consensus of low priority

Comments

@CasperWA
Copy link
Member

CasperWA commented Feb 6, 2020

OPTIONAL feature.

See Materials-Consortia/OPTIMADE#227.

@CasperWA CasperWA added enhancement New feature or request good first issue Good for newcomers priority/low Issue or PR with a consensus of low priority labels Feb 6, 2020
@ml-evs
Copy link
Member

ml-evs commented Feb 6, 2020

I have a vague memory of saying that I would do this a while ago... happy to knock something together. Any issue with adding jinja2 as a dependency (so that the "splash page" can be dynamically populated with the current endpoints) or would we prefer to maintain a static extra html file?

@CasperWA
Copy link
Member Author

CasperWA commented Feb 6, 2020

I have a vague memory of saying that I would do this a while ago... happy to knock something together. Any issue with adding jinja2 as a dependency (so that the "splash page" can be dynamically populated with the current endpoints) or would we prefer to maintain a static extra html file?

I guess it's fine? As long as it's not a default dependency.
Just checking dependencies of FastAPI and they use it as well, but not as default. Maybe add it to server?
Just keep in mind that others may want to be able to use the index meta-database but set up their own landing page.

@ml-evs
Copy link
Member

ml-evs commented Feb 7, 2020

I have a vague memory of saying that I would do this a while ago... happy to knock something together. Any issue with adding jinja2 as a dependency (so that the "splash page" can be dynamically populated with the current endpoints) or would we prefer to maintain a static extra html file?

I guess it's fine? As long as it's not a default dependency.
Just checking dependencies of FastAPI and they use it as well, but not as default. Maybe add it to server?
Just keep in mind that others may want to be able to use the index meta-database but set up their own landing page.

Indeed, given how simple this is it might be better for us to write an html file ourselves without any extra deps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers priority/low Issue or PR with a consensus of low priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants