Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.65 KB

doc.md

File metadata and controls

78 lines (53 loc) · 3.65 KB
Raw

Project Documentation

Steps Followed From Scratch

WEB2.0 bits

Initial Setup

  1. Initialized an empty TypeScript project in the backend folder by running the following command:

    npm init -y

    to creat a package.json

  2. Then To configure TypeScript for the project, I installed TypeScript as a development dependency:

    npm install typescript --save-dev

  3. Created a tsconfig.json file to define the compiler options:

    npx tsc --init

  4. In tsconfig.json specified "outDir": "./dist" & "rootDir": "./src".

App Setup

  1. index.ts needs express, so installed npm install express @types/express

  2. Intialized AWS EC2 instance, S3 scalable cloud storage (bucket setup) and cloudfront CDN

  3. Initialized (next app) user & worker frontends прх create-next-app

  4. Designed schema using postgres(DB) & prisma(ORM) by installing npm i prisma under bsckend and then initialised npx prisma init to set up Prisma ORM(by writing tables) and then migrated to postgres npx prisma migrate dev

  5. Added endpoints for User and Worker routes and for sso installing JWT npm i jsonwebtoken later npm i --save-dev @types/jsonwebtoken to prevent type error

  6. to compile code tsc -b & to run node dist/index.js and tested through postman.

Getting PresignedURL's

(Generate presigned URL's nodejs s3)

  1. through npm i @aws-sdk/client-s3 as well as npm i @aws-sdk/s3-presigned-post and this endpoint making through authmiddleware to identify user
  2. make sure of created IAM user to be assigned to one of the security groups that are related to buckets and also make sure to not include token in headers.
  3. Added npm i zod after making changes in index.ts to parse data that user send to bakcend through body [basically to validate input send by user].
  4. re migrated schema as removed option_id from options npx prisma migrate dev --name emove_option_id and regenerate client through npx prisma generate.
  5. tested task end point(post) with json on postman { options: [ { imgUrl: 'asd' }, { imgUrl: 'Fandom_image_url' }, { imgUrl: 'random_image_url' } ], signature: '0x123123123' }
  6. tested task(get) endpoint http://localhost:3000/v1/user/task?taskId=1
  7. creting endpoints to worker and removed bal_id from worker schema and migrated npx prisma migrate dev --name remove_balid_worker then generated npx prisma generate undr be.
  8. Again modified Task schema by altering it with done col, so migrate and generate.
  9. once again npx prisma migrate dev --name added_unique_constraint and regenerate.

Front End(FE)

  1. added cors package npm i cors @types/cors to enable communication between backend (BE) and FE as they both hosted on different ports
  2. under user fe created appbar, hero, upload and uploadImage files and tested AWS s3 connection to fetch images through cloudfront url with status 200ok.
  3. created dynamic routes folder cd app && mkdir -p task/\[taskId\] to contain page.tsx touch "task/[taskId]/page.tsx"that returns specific options submitted userId == taskId
  4. developed worker fe and user fe to track task submissions and psots resepectively.

WEB3.0 STUFF

  1. Installing npm install --save \ @solana/wallet-adapter-base \ @solana/wallet-adapter-react \ @solana/wallet-adapter-react-ui \ @solana/wallet-adapter-wallets \ @solana/web3.js under user fe and then npm i tweetnacl & npm i @solana/web3.js in user be to make connections, and get tx signtr & blockhashes.

  2. did as same as above in worker fe and be as well

  3. wrapped entire code base with wallet provider as a context with layout.ts in root level