Research Platform

This project is put together with turborepo and git modules.

Object storage module : https://github.com/Mahmoud-nfz/object-storage-solution

The architecture:

Turborepo Apps:

• Frontend: Next.js 14
• Backend: Nest.js

Each package/app is 100% TypeScript.

How do I run this?

Run the following command:

# Https is set as default way to fetch repositories
# For SSH Users: you should run:
# git config submodule.apps/object-storage-solution.url git@github.com:Mahmoud-nfz/object-storage-solution.git
# git submodule sync

# if running for the first time :
# git submodule update --init --recursive
git submodule update --remote --merge
docker compose up

Turborepo

Build

To build all apps and packages, run the following command:

pnpm build

Develop

To develop all apps and packages, run the following command:

pnpm dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link