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 the API #21

Merged
merged 35 commits into from
Apr 2, 2021
Merged

Update the API #21

merged 35 commits into from
Apr 2, 2021

Conversation

azangru
Copy link
Collaborator

@azangru azangru commented Mar 1, 2021

  • Menus have been updated and the transformation of toc.ymls into menu data type formalised.
  • Sequelize was replaced with TypeORM, as a more fully-featured typescript-friendly ORM. Database requirements are so simple that they could have been solved without any ORM, but an ORM adds extra convenience.
  • Data models were updated, as were relationships between them. Previously, the code used to have Articles and Videos as two separate models, with a one-to-many relationship between articles and videos. It has become clear that:
    • videos are going to have their own pages
    • videos are going to be included in the menus
    • videos may have related articles of their own
    • related articles and related videos can mix together in a single list of related items
    • database needs to store the order of related articles and videos
      Therefore, this PR promotes videos to articles in their own right, and adds storing of the order of related articles and videos.

Also, some of the more naive code (e.g. parsing paths manually instead of using node's path module) got updated.

@azangru azangru force-pushed the about-ensembl-type-orm branch from 2f5cc93 to a3460c3 Compare April 2, 2021 15:26
@azangru azangru merged commit f19ab8e into master Apr 2, 2021
@azangru azangru deleted the about-ensembl-type-orm branch April 2, 2021 15:28
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

Successfully merging this pull request may close these issues.

1 participant