cTypeHub

The source code of https://ctypehub.galaniprojects.de

Prerequisites

Make sure you installed these required software before running this project:

• Node.js
• pnpm
• Docker

Start the app locally

After having cloned the repository on your local machine and defining all environment variables according to the .env.example, to start the app locally follow this steps.

1. Make sure you have all dependencies installed, running:

   pnpm install
   

2. Start the database the app will use, running:

   pnpm start-db
   

   The Docker daemon needs to be running for this to work

If there is already a postgres container running, with an incompatible database, you can stop it with pnpm stop-db.

3. Enter the dev watch mode from astro, running:

   pnpm dev
   

Now you can see the logs of the backend on the terminal and visit the frontend under the URL specified by the variable URL from the .env-file. (By default http://localhost:3000)

The database should start to populate from the configured indexer.

Interacting with sequelize

This project consciously did not define a config/config.json for sequelize. Instead, it relies on the url property inside .sequilizerc. In turn, the url takes process.env.DATABASE_URI as a value.

Before introducing any changes to the database structure you new to recreate the past. For this follow these steps:

1. Make sure you have all dependencies installed, running:

   pnpm install
   

2. Start the database, if not running yet. Locally, you can run:

   pnpm start-db
   

3. Run all past migrations, via:

   pnpm migrate
   

4. Start the project to populate the database, by running:

   pnpm dev
   

   After a while, you can stop the project, but the postgres container should continue running.

5. Add the seeds to the database, by running:

   pnpm seed
   

   Because the seeds depend on some data, the database needs to be previously populated.