Skip to content

Latest commit

聽

History

History
53 lines (33 loc) 路 2.25 KB

File metadata and controls

53 lines (33 loc) 路 2.25 KB

Nowdatabase

NOW - New and Old Worlds - Database of fossil mammals

Rebuild of a fossil database application, old version at https://nowdatabase.luomus.fi/

The new version is not deployed yet.


Developer documentation

Basic commands 馃捇

  • npm run setup
    • Creates all files and directories required to run the project
  • npm run dev
    • Runs the application in development mode
    • Supports hot reloading
    • Serves frontend by default at http://localhost:5173
  • npm run test:api
    • Runs api-tests inside Docker
    • Requires database to be running (start one with correct data: npm run start:anon:api)
  • npm run test:e2e
    • Runs api-tests inside Docker
    • Requires frontend, backend and database to be running (start all with npm run start:anon)

Further documentation

馃殌 Setup app & restore db How to get the app up & running, and initialize database from sql-dumps

鈱笍 List of all commands A comprehensive list of all of the most important commands

馃檶 Contributing & integration flow Where to commit? Where are tests run? How is the code deployed?

馃摑 Frontend Explanation of the frontend logic and how to add views

馃搼 Species synonym creation flow Backend write logic overview used by the synonym API tests

馃攷 Validators The readme explains how validators are written

馃攷 Class diagram See the relations of relevant tables. Notice that it omits some unimportant tables and does not show most columns.

馃實 Map features Maps' functionality and development notes

DeepWiki documentation for the NOW database can be found here: Ask DeepWiki


Documentation index

See documentation/README.md for the full documentation tree (includes reviewer notes, FAQ, and a complete list of docs).