How if I want to take the API only?
Novienzi opened this issue · 8 comments
can I take the API only from roomler? But I am getting confused when seeing the roomler.config dependencies. Thanks
Hi @Novienzi ,
u cannot take only roomler.api. All /packages are layers of a single app roomler.
In other words, multiple packages are managed via
https://github.com/lerna/lerna as a single app.
All you need yo do is run:
npx lerna boostrap
in the root folder and it will install all /packages/package.json dependencies as a single app.
okay, thank you for the response. But can I use the API for another application if in case I want to develop this app on mobile?
Yes, you can easily develop a new UI package e.g. a react native that will talk to roomler.api.
Okey, thanks a lot.
Then, would you mind if describe the API schema for general like who is able to create room, or where I have to go (which API) after login to create room, etc?
Thank you
The route /docs, e.g. if you have started it locally http://localhost:3000/docs, is the SWAGGER route, that describes all API routes and their schemas.
You can find the schem descriptions inside: https://github.com/gjovanov/roomler/tree/master/packages/api/routes e.g.
https://github.com/gjovanov/roomler/blob/master/packages/api/routes/room/room-schema.js
also Swagger is available at: https://roomler.live/docs
Closing...