nowdatabase/README.md

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 dev
  • Uses docker-compose.dev.yml
  • Run in development mode: with hot reload
• npm start
  • Uses docker-compose.yml
  • Code is compiled like in production, but using the same local test database as the above command.

Further documentation

The 📂 documentation-directory has documentation for developers. Remember to update it if you modify something important like project architecture.

🚀 Initialize app & restore db

• How to get the app up & running, and initialize database from sql-dumps

🔧 Technical explanations

• Explanations of how things work, and guides for some more rare tasks like generating sequelize models.

🙌 Contributing & integration flow

• Where to commit? Where are tests run? How is the code deployed?

Typing the API

• How to bring types from backend to frontend

📝 Frontend

• Explanation of the frontend logic and how to add views

🔎 Class diagram

• See the relations of relevant tables. Notice that it omits some unimportant tables and does not show most columns.