/cosmicds-portal

User portal for Cosmic Data Stories

Primary LanguagePythonMIT LicenseMIT

please update the URLs accordingly

Built Status ReadTheDocs Coveralls PyPI-Server Conda-Forge Monthly Downloads Twitter
Project generated with PyScaffold

CosmicDS Portal

Front-end user portal for users and educators to setup classes and data stories.

Starting the Server

To run the portal locally, there are a series of steps needed to setup the local instance:

  1. Clone the repo locally, then change to the package directory. Install the portal package using
$ pip install .
  1. Generate a local test database by running the models.py file
$ cd src
$ python models.py

You should see a new `database.db` file in the package directory.
  1. Start the database access api server:
$ uvicorn cosmicds_portal.server:app --reload
  1. Start the Solara portal app (ask @nmearl for the required access tokens if needed)
$ SOLARA_SESSION_SECRET_KEY="SECRETTESTKEY" SOLARA_OAUTH_CLIENT_ID="..." SOLARA_OAUTH_CLIENT_SECRET="..." SOLARA_OAUTH_API_BASE_URL="..." SOLARA_OAUTH_SCOPE="openid profile email" SOLARA_SESSION_HTTPS_ONLY=false solara run cosmicds_portal.pages --port=8865