This is a Nuxt application, which is a structured way to do Vue development. Look at the Nuxt 3 documentation to learn more. We use pinia in some places for state management, see pinia docs and within this project see DatasetStore.js.
Make sure to install the dependencies:
npm installWe use a cookie for authentication so you need to use the same domain for the front end and the API.
The easiest way to do this is to add an entry in your /etc/hosts file like this:
127.0.0.1 local.kpndataregistry.org
If you're running the API server locally and want to access it from your local front end dev
server, in your .env file set NUXT_PUBLIC_API_BASE_URL=http://local.kpndatregistry.org:5000 as
an example.
If you're only making front end changes and want to use the qa deployed api server, in your .env
set NUXT_PUBLIC_API_BASE_URL=https://api.kpndataregistry.org but you'll need to use https when
serving this project because QA is https and browsers don't allow you to mix http and https communications.
You can set up https proxy back to you dev server by using this docker file. Build and
start that container and then start your dev server as per the instructions below and you'll be
able to access the front end at https://local.kpndataregistry.org:8000.
To start the development server:
npm run dev-auth # with authentication (you'll need to point to an API server and use *.kpndataregistry.org host name)
npm run dev # without authentication (you can just localhost)Deploy to QA occurs automatically upon push to the main branch via github actions.
You can deploy to Production by pushing a semantic version tag to the repo.
The tag should be of the form V#.#.#, and ideally the tag should point to a commit on the main branch.
You can use the next_release.py script to determine what the next tag should be.
python next_release.py and choose your release type (major, minor, or patch) at the prompt.
You can read more about creating and publishing tags here.
A sample .env file is provided, .env-sample. It should be copied to the root directory and renamed to .env. The following environment variables are required:
NUXT_PUBLIC_API_SECRET=??
NUXT_PUBLIC_API_BASE_URL=??
NUXT_PUBLIC_PHENOTYPES_URL=??