We need a logging and monitoring mechanism. We can use Winston

We can discuss here about our options: evrimagaci/periodum#76

This task can be done after #1 completed

We should have an endpoint that returns all the elements with these properties.

{
  atomic_mass
  boil_use
  melt_use
  block
  type
  symbol
  searchClass
  name_tr
  number
  xpos
  ypos
}

Since Discussion doesn't seem useful, let's discuss here.

Recently, fastify is appealing to me. Benchmarks are insane!

Thinking to switch from express to fastify. What do you think? Anyone experienced?

Currently, let's not put this as a task in the Projects.

Since now we have imported existing db #10 feature done, we can start to implement fully support of existing API only related parts -> https://github.com/evrimagaci/periodum/blob/main/server/routes.js#L7-L97

End points should NOT contains "api" since this app is going to work on "api.periodum.com"

Future implementations or good to have at the beginning if possible:

• Rate Limiter (we can use a library)

PS: This can be implemented after #2 task

Due to limited very types in MySQL (array type) we would like to switch to PostgreSQL.

• Create an initial migration.
• Import elements and isotypes through db seeding from local JSON files.
• Update README accordingly

Prisma's Related Docs:

• https://www.prisma.io/docs/guides/database/developing-with-prisma-migrate/add-prisma-migrate-to-a-project
• https://www.prisma.io/docs/guides/database/seed-database

Note: JSON files can be generated through current api endpoints:

• https://periodum.com/api/elements
• https://periodum.com/api/isotopes

Create the project structure based on README Tech Stack

• Create Code Base (NodeJS, NPM or YARN, TypeScript)
• Dockerize The Project
• Complete the PR's tasks

Per our conversation with @nesimtunc, here are the tasks that need to be done

• Create a table in the DB for keeping track of the imported/failed compounds.
• Use that table to rerun the script if the script crashes unexpectedly.
• Limit retry amounts for failed compounds.
• Create an endpoint to show the statistics, ie: the time to import a number of compounds, success/fail ratio, how many compounds are left to import
• Create a POST endpoint to trigger the import script with an authentication(token may be stored in .env) header with a JSON body that includes the startID and endID and an option to continue from the last compound
• Create a POST endpoint to trigger pause and stop the import script

Originally posted by @T410 in #16 (comment)

Current Docker environment is only development purpose. We need a production environment as well. It's no big task, we can just copy current settings and separate them individually.

Also, we might create Docker Images on Docker Hub and push automatically.

Maybe create a Wiki page.

TODOs:

• Copy Docs Template (issue, PR etc. ) from Main Project
• Separate DEV / PROD env. on Docker

Migrate from MySQL to MongoDB using Prisma.

The DB is in main project

For now, only GitHub actions would be enough for us to validate coding style, later after unit tests we can add that step too.

It should run lint

Please Read The WikiPages to complete script's requirements.

• Overview
• Script's implementation