- See the requirements page: https://developer.youcan.shop/apps/embedded_app/getstarted#requirements
- Make sure you have a MySQL server running, you can either use MAMP, WAMP, or a Docker MySQL image.
- Clone the repo
- Copy the contents of
.env.example
into a.env
file and fill their values cd
into the project- Run
pnpm install
to install the dependencies - Run
youcan auth login
to authenticate with YouCan - Run
pnpm prisma migrate dev
to generate the database and its tables. - Run
youcan app install
to install the app on your dev store. - Run
pnpm dev
to start the project and sync your settings with your partners app settings
youcan google sheet is a partner embedded app utilize
google service and youcan service to:
create, update, delete, sync orders
to the parner Google Spread Sheets using its own OAuth2 Credentials
- Service Layer : Bussiness logic
- Repository Layer : DB logic
- Types
- Validator
- Schemas : Validation Schemas
- Handler : (Response, Async, Sync, Catcher) and Error Handling
- Assets: Css
- Components
- Composables : Reusable Logic
- Layouts
- Pages
- Public: static Imgs
- Types
both frontend and backend is decoupled
- frontend: based on nuxt
- backend: based on nitroJS
- they can be (separated/attached at same time) :
- separated to microServices
- attached and share something like: error state: useError, sendError acc to the below pic
same as nuxt response
{
"statusCode": number,
"statusMessage": string,
"data": any,
"stack": [] //error stack empty if debug is disabled
}