[Feature Request] Custom API Repository Path about nhost

[johannesschobel]

Dear @elitan ,

thanks for answering to my issue / feature request.
A typical nrwl project is structured as follows:

apps\
  todos-www\
  todos-api\
  todos-mobile\
  todos-xyz\
libs\
  // no real defined structure of the libraries, may be feature-specific, or application specific, ...
package.json

So basically, all your apps reside in the apps folder, whereas the name of the application is customizable (does not need to be named api but can also be called backend-for-todos or whatever).

Note that nrwl follows the single package.json approach. i.e., there is only one single package.json file within the entire repository. Building specific apps (i.e., the api) is done using nrwl-specific command-wrappers, like

nx build <NAME>          // i.e., nx build backend-for-todos

This command, in turn, builds the project based on the workspace definition for this specific application. Furthermore, it finds related packages in the libs folder (i.e., libs/api/auth) and bundles it all together into one single application. This approach guarantees a highly reusable application structure.

In terms of the Custom API feature, I thought about having a settings parameter within the nhost admin console where the path within the repository may be customized. As a default value, the /api value may be provided. However, in my nrwl/nx setting, i could change it to apps/backend-for-todos ...

However, it is not clear to me, how i would "bundle" my application properly? Because i would need to build the app first to be deployed, right? Do we need to call custom npm scripts first?

All the best

[elitan]

Hi @johannesschobel

Yea I think this makes sense. We might not want to change the api/ folder but we could allow repositories with a Nhost app in a subfolder. Similar to https://vercel.com/blog/monorepos

Could you describe a bit more in detail your preferred folder structure for your monorepo?

[elitan]

This is now working: https://docs.nhost.io/platform/github-integration#base-directory