Breadcrumbs and general bug fixes. (#14)

* Working on Github Actions. * Working on Deployment. * Fix: Github Actions. * Fixed username. * Working on deployment. * Update clone-and-setup.yml * Update clone-and-setup.yml * Update clone-and-setup.yml * sanity commit. * snaity commit. * s. * sc. * logging. * Update app-deployment.yml * Update app-deployment.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Removing unused classes. * Update db-operations.yml * Update db-operations.yml * Update app-deployment.yml * Update app-deployment.yml * Working on deployment. * Update db-operations.yml * Update db-operations.yml * Update package.json * Working on Deployment migration runner. * Fixing docker network. * sc * Working on UI fixes. * Working on QR Download and schema changes. * Working on decoupling action from formData. * Minor changes. * Logging the migrations. * Debugging. * changing env name. * Update app-deployment.yml * Working on UI changes. * Dev (#13) * Working on Github Actions. * Working on Deployment. * Fix: Github Actions. * Fixed username. * Working on deployment. * Update clone-and-setup.yml * Update clone-and-setup.yml * Update clone-and-setup.yml * sanity commit. * snaity commit. * s. * sc. * logging. * Update app-deployment.yml * Update app-deployment.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Removing unused classes. * Update db-operations.yml * Update db-operations.yml * Update app-deployment.yml * Update app-deployment.yml * Working on deployment. * Update db-operations.yml * Update db-operations.yml * Update package.json * Working on Deployment migration runner. * Fixing docker network. * sc * Working on UI fixes. * Working on QR Download and schema changes. * Working on decoupling action from formData. * Minor changes. * Logging the migrations. * Debugging. * changing env name. * Update app-deployment.yml * Working on UI changes. * Resolved bug; consolidated migrations. * Dev (#1) * Baseline for Master (#12) * Working on Github Actions. * Working on Deployment. * Fix: Github Actions. * Fixed username. * Working on deployment. * Update clone-and-setup.yml * Update clone-and-setup.yml * Update clone-and-setup.yml * sanity commit. * snaity commit. * s. * sc. * logging. * Update app-deployment.yml * Update app-deployment.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Update db-operations.yml * Removing unused classes. * Update db-operations.yml * Update db-operations.yml * Update app-deployment.yml * Update app-deployment.yml * Working on deployment. * Update db-operations.yml * Update db-operations.yml * Update package.json * Working on Deployment migration runner. * Fixing docker network. * sc * Working on UI fixes. * Working on QR Download and schema changes. * Working on decoupling action from formData. * Minor changes. * Logging the migrations. * Debugging. * changing env name. * Update app-deployment.yml * Resolved bug; consolidated migrations. * Removing caching for docker. * bug fix. * Breadcrumbs.
ONDC-Official · Jan 14, 2025 · 443a31c · 443a31c
1 parent ad62ce3
commit 443a31c
Show file tree

Hide file tree

Showing 31 changed files with 335 additions and 322 deletions.
diff --git a/.github/workflows/app-deployment.yml b/.github/workflows/app-deployment.yml
@@ -37,7 +37,8 @@ jobs:
             
             echo "STARTING build"
             sudo cp docker-compose.dev.yml docker-compose.yml
-            sudo docker compose up ondc_deep_link_app -d --build
+            sudo docker compose build --no-cache ondc_deep_link_app && sudo docker compose up -d ondc_deep_link_app
+
             sudo docker system prune -f
 
             

diff --git a/deeplink-generator/README.md b/deeplink-generator/README.md
@@ -1,36 +1,51 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# Deep Link v2
+This repo holds the code for Deep Link v2 App. It is a utility provided to generate usecases from predefined templates. There are 3 personas concerned in this app. These personas are:
+1. Admin
+2. User
+3. Consumer
 
-## Getting Started
+Out of these, currently, the User flow has been enabled. Remaining flows are under development and will be introduced in future releases.
 
-First, run the development server:
+## Admin
+The admin is responsible to **creating** templates. These templates inherit schema from the Base Beckn template. The admin can then add fields to the template. There are 3 types of fields:
+1. Pre-filled - These fields are defined and their values are provided by the admin. These fields are not editable by the user. So any usecase created with these templates will have the same values for these fields.
+2. User-filled - The admin can mark a field as "user-filled". This field will be editable by the user. The user can provide their own values for these fields during usecase generation.
+3. PG - These fields are filled during consumption phase. The usecase created with the template will have these fields marked and the resolver server will communicate with the agent to fill these fields.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## User
+The user is responsible to **creating** usecases. The user can select a template and then add fields to the template. The user can then generate the usecase. The usecase will be generated in the form of a JSON file. The user can then use this JSON file to create a usecase on the Beckn network.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+The usecases may be kept private or public (saveed to GitHub). Additionally, when the usecase is either published privately (submitted) or published, the usecase QR is saved on Github. This QR contains the ID of the usecase. The resolver server can then use this ID to fetch the usecase.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Consumer
+The consumer is responsible to **consuming** usecases. The consumer can scan the QR of the usecase and the resolver server will fetch the usecase. The resolver server will then communicate with the "consuming" agent to fill the fields marked as PG. The resolver server will then return the usecase to the consumer. The consumer can then use this usecase to create a usecase on the Beckn network.
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+Currently, hitting `/api/resolver/{usecase_id}` will resolve the usecase. *Note*: While this returns the usecase, it does not resolve the usecase. The usecase is resolved when the resolver server communicates with the agent and all the post-generation fields are filled. **Post Generation fields are denoted with `{{<value>}}`.
 
-## Learn More
+## Developer Guide
 
-To learn more about Next.js, take a look at the following resources:
+This section is meant for developers who want to contribute to the project. The project is built using NextJS and PostgreSQL. Prisma ORM has been used.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+### Prerequisites
+Knowledge of NextJS 15, TypeScript, PostgreSQL, Docker, Docker Compose, Prisma ORM, and Beckn Protocol is required.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+You need to have the following before you can start developing:
+1. NodeJS (^22.0)
+2. Docker & Docker Compose
 
-## Deploy on Vercel
+### Steps to start the project
+1. Clone the repo
+2. RUN `cd deeplink-generator`
+3. Run `npm install`
+4. Copy the `example.env` file to `.env` and update the values as needed.
+5. Copy the `docker-compose.local.yml` to `docker-compose.yml`.
+6. RUN `docker compose up ondc_deep_link_db -d`. This will start the database in a docker container.
+7. RUN `npx prisma migrate dev` followed by `npx prisma seed` to seed the database.
+8. RUN `npm run dev` to start the project.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+### Seeding the database
+The database comes pre-seeded with the templates defined inside the `seeding` directory once step 7 in the previous sub-section is completed. The seeding script automatically picks up on the usecase category and sub-category as defined in the templates and seeds them accordingly.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+## Contributors: 
+1. [Abhik Banerjee](https://github.com/abhik-wil)
+2. [Sonali Shakya](https://github.com/sonalishakya)
diff --git a/deeplink-generator/docker-compose.local.yml b/deeplink-generator/docker-compose.local.yml
@@ -5,7 +5,6 @@ services:
       - "8080:3000"
     environment:
       - DATABASE_URL=${DATABASE_URL}
-      - ENV=${ENV}
     depends_on:
       - ondc_deep_link_db
 
@@ -23,17 +22,7 @@ services:
     ports:
       - "5432:5432"
     environment:
-      - POSTGRES_USER=${DB_USER}
-      - POSTGRES_PASSWORD=${DB_PASS}
-      - POSTGRES_DB=${DB_NAME}
+      - POSTGRES_USER=${POSTGRES_USER}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+      - POSTGRES_DB=${POSTGRES_DB}
 
-  ondc_deep_link_nginx:
-    image: nginx:alpine
-    ports:
-      - "80:80"
-      - "443:443"
-    volumes:
-      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
-      - ./ssl:/etc/nginx/ssl:ro
-    depends_on:
-      - ondc_deep_link_app
diff --git a/deeplink-generator/example.env b/deeplink-generator/example.env
@@ -0,0 +1,9 @@
+POSTGRES_USER=
+POSTGRES_PASS=
+POSTGRES_NAME=
+DATABASE_URL=
+
+ACCESS_TOKEN_REPO=
+OWNER_NAME_REPO=
+STORAGE_REPO_NAME=
+
diff --git a/deeplink-generator/nginx/nginx.conf b/deeplink-generator/nginx/nginx.conf
diff --git a/deeplink-generator/prisma/migrations/20241213065301_init/migration.sql b/deeplink-generator/prisma/migrations/20241213065301_init/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241216062431_making/migration.sql b/deeplink-generator/prisma/migrations/20241216062431_making/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241216063510_ynuque/migration.sql b/deeplink-generator/prisma/migrations/20241216063510_ynuque/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241218052010_qr/migration.sql b/deeplink-generator/prisma/migrations/20241218052010_qr/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241224045445_tuncate_uuid/migration.sql b/deeplink-generator/prisma/migrations/20241224045445_tuncate_uuid/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241224045549_desc/migration.sql b/deeplink-generator/prisma/migrations/20241224045549_desc/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20241227074217_xyz/migration.sql b/deeplink-generator/prisma/migrations/20241227074217_xyz/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20250106065259_category_sub/migration.sql b/deeplink-generator/prisma/migrations/20250106065259_category_sub/migration.sql
diff --git a/deeplink-generator/prisma/migrations/20250106084158_dev/migration.sql b/deeplink-generator/prisma/migrations/20250106084158_dev/migration.sql