From f6f8fa07344cc67424f9c82c283927198e3e6986 Mon Sep 17 00:00:00 2001 From: Eric Cabrel TIOGO Date: Sun, 4 Aug 2024 16:03:43 +0200 Subject: [PATCH] feat(backend): build the homepage --- .changeset/beige-experts-occur.md | 5 ++ .../actions/install-dependencies/action.yml | 2 +- .github/workflows/build.yml | 2 +- .github/workflows/deploy-frontend.yml | 2 +- apps/backend/Dockerfile | 10 +-- apps/backend/jest.config.ts | 2 +- apps/backend/nest-cli.json | 10 ++- apps/backend/package.json | 5 +- apps/backend/src/app.module.ts | 12 +++- apps/backend/src/assets/favicon.ico | Bin 0 -> 15406 bytes apps/backend/src/assets/index.html | 65 ++++++++++++++++++ .../src/features/app/app.controller.ts | 11 --- .../src/features/app/app.integration.spec.ts | 2 +- apps/backend/src/main.ts | 2 +- apps/backend/tsconfig.json | 1 + package.json | 2 +- yarn.lock | 30 ++++++++ 17 files changed, 132 insertions(+), 31 deletions(-) create mode 100644 .changeset/beige-experts-occur.md create mode 100644 apps/backend/src/assets/favicon.ico create mode 100644 apps/backend/src/assets/index.html delete mode 100644 apps/backend/src/features/app/app.controller.ts diff --git a/.changeset/beige-experts-occur.md b/.changeset/beige-experts-occur.md new file mode 100644 index 00000000..67d43312 --- /dev/null +++ b/.changeset/beige-experts-occur.md @@ -0,0 +1,5 @@ +--- +'@snipcode/backend': patch +--- + +Build the backend API homepage diff --git a/.github/actions/install-dependencies/action.yml b/.github/actions/install-dependencies/action.yml index b8183e02..59984267 100644 --- a/.github/actions/install-dependencies/action.yml +++ b/.github/actions/install-dependencies/action.yml @@ -24,7 +24,7 @@ runs: shell: bash run: | corepack enable - yarn set version 4.3.1 + yarn set version 4.4.0 - name: Install projects dependencies shell: bash diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3d5a1fb0..9a9b19c0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -68,7 +68,7 @@ jobs: - name: Install Yarn 4 run: | corepack enable - yarn set version 4.3.1 + yarn set version 4.4.0 - name: Install Vercel CLI run: npm install --global vercel@latest diff --git a/.github/workflows/deploy-frontend.yml b/.github/workflows/deploy-frontend.yml index 8c49e4ef..0ca41291 100644 --- a/.github/workflows/deploy-frontend.yml +++ b/.github/workflows/deploy-frontend.yml @@ -23,7 +23,7 @@ jobs: - name: Install Yarn 4 run: | corepack enable - yarn set version 4.3.1 + yarn set version 4.4.0 - name: Install Vercel CLI run: npm install --global vercel@latest diff --git a/apps/backend/Dockerfile b/apps/backend/Dockerfile index ae4152ab..70bdfd94 100644 --- a/apps/backend/Dockerfile +++ b/apps/backend/Dockerfile @@ -6,7 +6,7 @@ WORKDIR /app COPY . . -RUN corepack enable && yarn set version berry +RUN corepack enable && yarn set version 4.4.0 RUN yarn install @@ -35,7 +35,7 @@ ENV APP_VERSION=${APP_VERSION} WORKDIR /app -RUN corepack enable && yarn set version berry +RUN corepack enable && yarn set version 4.4.0 COPY --chown=node:node --from=builder /app/package.json . COPY --chown=node:node --from=builder /app/.yarnrc.yml . @@ -43,12 +43,6 @@ COPY --chown=node:node --from=builder /app/.yarnrc.yml . COPY --chown=node:node --from=builder /app/apps/backend/dist/src ./apps/backend/src COPY --chown=node:node --from=builder /app/apps/backend/package.json ./apps/backend -COPY --chown=node:node --from=builder /app/apps/backend/src/features/schema.graphql ./apps/backend/src/features/schema.graphql -COPY --chown=node:node --from=builder /app/apps/backend/src/features/users/graphql/schema.graphql ./apps/backend/src/features/users/graphql/schema.graphql -COPY --chown=node:node --from=builder /app/apps/backend/src/features/snippets/graphql/schema.graphql ./apps/backend/src/features/snippets/graphql/schema.graphql -COPY --chown=node:node --from=builder /app/apps/backend/src/features/folders/graphql/schema.graphql ./apps/backend/src/features/folders/graphql/schema.graphql -COPY --chown=node:node --from=builder /app/apps/backend/src/features/auth/graphql/schema.graphql ./apps/backend/src/features/auth/graphql/schema.graphql - COPY --chown=node:node --from=builder /app/packages/domain/package.json ./packages/domain/package.json COPY --chown=node:node --from=builder /app/packages/domain/dist ./packages/domain/dist diff --git a/apps/backend/jest.config.ts b/apps/backend/jest.config.ts index b48aaa30..281ec792 100644 --- a/apps/backend/jest.config.ts +++ b/apps/backend/jest.config.ts @@ -5,7 +5,7 @@ const config: Config.InitialOptions = { maxWorkers: 1, moduleFileExtensions: ['js', 'json', 'ts'], preset: 'ts-jest', - roots: ['.'], + roots: ['src'], snapshotFormat: { printBasicPrototype: false, }, diff --git a/apps/backend/nest-cli.json b/apps/backend/nest-cli.json index f9aa683b..5fbe064d 100644 --- a/apps/backend/nest-cli.json +++ b/apps/backend/nest-cli.json @@ -3,6 +3,14 @@ "collection": "@nestjs/schematics", "sourceRoot": "src", "compilerOptions": { - "deleteOutDir": true + "deleteOutDir": true, + "assets": [ + { "include": "assets", "outDir": "dist/src", "watchAssets": true }, + { "include": "features/schema.graphql", "outDir": "dist/src", "watchAssets": true }, + { "include": "features/auth/graphql/schema.graphql", "outDir": "dist/src", "watchAssets": true }, + { "include": "features/folders/graphql/schema.graphql", "outDir": "dist/src", "watchAssets": true }, + { "include": "features/snippets/graphql/schema.graphql", "outDir": "dist/src", "watchAssets": true }, + { "include": "features/users/graphql/schema.graphql", "outDir": "dist/src", "watchAssets": true } + ] } } diff --git a/apps/backend/package.json b/apps/backend/package.json index fbc74742..ca2a93a3 100644 --- a/apps/backend/package.json +++ b/apps/backend/package.json @@ -8,8 +8,8 @@ "scripts": { "build": "nest build", "clean": "rm -rf .turbo dist build logs", - "dev": "dotenv -e .env.local -- nest start --watch", - "dev:debug": "nest start --debug --watch", + "dev": "dotenv -e .env.local -- nest start --watch --watchAssets", + "dev:debug": "dotenv -e .env.local -- nest start --debug --watch", "gql:gen:types": "ts-node scripts/generate-graphql-types.ts", "lint": "eslint \"{src,scripts}/**/*.ts\" --fix", "prod": "node dist/main", @@ -27,6 +27,7 @@ "@nestjs/core": "10.3.9", "@nestjs/graphql": "12.1.1", "@nestjs/platform-express": "10.3.9", + "@nestjs/serve-static": "4.0.2", "@prisma/client": "5.14.0", "@sentry/node": "8.11.0", "@snipcode/domain": "workspace:*", diff --git a/apps/backend/src/app.module.ts b/apps/backend/src/app.module.ts index fe837dce..76524cc5 100644 --- a/apps/backend/src/app.module.ts +++ b/apps/backend/src/app.module.ts @@ -1,13 +1,15 @@ +import { join } from 'path'; + import { ApolloServerPlugin } from '@apollo/server'; import { ApolloServerPluginLandingPageLocalDefault } from '@apollo/server/plugin/landingPage/default'; import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo'; import { Logger, Module } from '@nestjs/common'; import { ConfigModule, ConfigService } from '@nestjs/config'; import { GraphQLModule } from '@nestjs/graphql'; +import { ServeStaticModule } from '@nestjs/serve-static'; import { DomainModule } from '@snipcode/domain'; import { EnvironmentVariables, validate } from './configs/environment'; -import { AppController } from './features/app/app.controller'; import { AppService } from './features/app/app.service'; import { AuthFeatureModule } from './features/auth/auth.module'; import { FolderFeatureModule } from './features/folders/folder.module'; @@ -19,7 +21,7 @@ import { DateScalar } from './utils/graphql/date-scalar'; const explorerPlugin: ApolloServerPlugin[] = IS_DEV ? [ApolloServerPluginLandingPageLocalDefault({ embed: true })] : []; @Module({ - controllers: [AppController], + controllers: [], imports: [ ConfigModule.forRoot({ envFilePath: ['.env.local', '.env.test'], @@ -54,6 +56,12 @@ const explorerPlugin: ApolloServerPlugin[] = IS_DEV ? [ApolloServerPluginLanding }; }, }), + ServeStaticModule.forRoot({ + exclude: ['/graphql', '/auth*', '/snippets*'], + renderPath: '/', + rootPath: join(__dirname, 'assets'), + serveRoot: '/', + }), AuthFeatureModule, FolderFeatureModule, SnippetFeatureModule, diff --git a/apps/backend/src/assets/favicon.ico b/apps/backend/src/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..2c6859a36b01e48f0a4099a098da36c41b10e136 GIT binary patch literal 15406 zcmeI2d9+UD9>-rvhRkV_;h@CTAWFAVX^;k_>z1VnEnQ8d7M0Sl(&RQN8a2@^S!pgx zu7-PQLR3;J>6Y7wkR;Ome760(Yw!2G?{Us?{B_%Feb@IlJ;Q$X^ZcG?@Au7QDrG8X z>ekJ`MVYg<&SW}dGMS>Hje4tknal&&+P01TEi;*!+h;PZh@l82Hrk<5UBCbSdwVc) z!-frihp!j0d;{{{g(|_f4RP0i0mxNzu?`Hm`v&B=kZan3if{Vbl_zuvA+zY&e z-V%%k-fLs{1kleI_*`XhHMj*-Bj!oaFt%&!3c7$E;0VikAzOBoGVwQq>p*pEj>mQI zneZ^U3hdZi0xE-D!Bg0-fh&PJ;3{wo=xTjl$UQ9=%T3TPMYnHrk&lmpHpZQZ-U(F3 zH#T8!h3+%12hV{W%kIGb+#T0z`}cwH%nwICKh#0olptfT9G9`5{gv_i+zt#evHvve z&cm(1aPa4(AKxTwwPDBPq@*v%*!Rcp96l9!0to$cK3}B|ZWrPUF)@3AqlmXZ`+$*v zm0q@sGJSz_AsU0Sl`dVhd8P<-0_La9y}0M?=&y78VdVG0D&*f`ua#gfcn~8m5lwl)nY`-fjeqN>k1l z$~6OHD6NW^3TMI=4H54#0I^ zE5vMyiETug&Tt=aPK-X-js<&wR6o%B1E24QU>&k^>KDlT@>{H9+OP!qS@=RY+Ji!0 z(2vIM9`t1#zXtg;FbBL1-o?HMb`Grv^MU)&DexTlc5o#9@3H?iQT;IXOxNo|SoF5M*V@i^VtqTT%MZmH83JgFjQ!b&* zqjB4N!mBA?VjjcqUbai<8@hAlY;51d_G2EjU+|a2#5MwJi8oETUS^?RTv8cg%$Jwu z#$fYYVNUn@m3rK_9gl5tV}p)w6fx6-j@$=)jlD*&B^mpXz_~apX-~@d`ccQvaC9M` zmGlQ0XES_j;Lh4$_ciCtVlX_!1tzvW2=jUaF-?Lmm+_gOqbn|xT5HDRoD9q>`^S0< zV#lJN4m%H0`3BoA*d_v>@qDOTT&@SY>){z};a(0z_uMiaxIYXsHeBcfu{%aB;ZNau z;4tJ*V9ySo3txj%a~Yfc^E%nO;I7!dh5Nz-z%t~Hp`AFUGPa^%L+%281!rrc%u?jN zfOXB)hTI(d2u7-h3*GVZiq6@@KLWDz75hjqCdB75zAnT&w)X`evd`NbYpz_7u$#-) zf^&im`EBC7YHLHk2|TKd&H3XqEw(mdzq!J7@g&R}$;J!a@oNV>FRu)C8JlNC=jbWw z$mY>C%3jDjfDeFq^kZQEQhPqO#^5>ZUJrq6+sM9ixSnV$t{W{yj_a^c( z<#1UJbOMfHcD^8+AFn3fGl2JfVJH(Adk5^_2OW7j$c}fg6BpGBPsYDI*prMeniFsv za2r?wTq~Zd+b3g#jD0x%NeSINIy30GjL);{ddg+r&x}F86#Ear{VlqXzXs=^R0YM( zwAkF!7Jy!%9c-STm&2(wl<+%;yr)LNhCCFQkD?3F`#l>(ITYP<`Q;%#Ft%>^+{;t> z8QW#p-U6w6v>dh$!0YH(cg-vW--C77Q+XM^CU*18VWHi)TvhA~utzx{kI(!zJZX>1 zRi>Qdd`+%T9ee70L>;FC^GNC*(LGPT0cYoHvOesdk1W?SX;;Q}FJ<4)wdd1`bsXTh4;V9PzKl*-@_j#AN$K&q|T-$9zS&DfMbbh7Y-GV=ti93|| zA7JcNjZ9XuZNTqfS<yDw`vNH9YNImbxb)5j;1Lk4Rom-ycobxAvhmhZak1K0?h2p8J zBXwQ@wgU^%Zwax;=8uoy(V#9UagKy?QaMa9vkx%5Sl%0CrV|NlchzJTzFHq#eW#CH;^DR%Lkw&EFW54Qrn!5H9K z*Zkm_)VO(JGj`sSgfH6Hqd4j&;eWuUZNl7UW53aZIU^Md0 z0@?d|7)(X?OmFOW;5l$HdV7#}@2lXhoBNxBNx(hNe#`?ykR8t*;M%}*sCnHSB0P&$ zhs|fkxF27FY;KG01s;dqxT5Z9%*<2F|zd**PQ{dQ9B+(uc?g2z+WbYRYMj~WDT z7uu}|rcU?ADPRqF9=$s#_6}O!wy3i@=tZ5*#kF7(@;>FQFIkRy{B2?m@CM^3{U>Hy;@!KQ7X#6+1@|CNgr9+@!qb5H!nHdV+x6gl&<(T(1?vy(663ue z4h90xB+pWp-vK`XOMveULitlLhnSaPzlr%g27%CC^gR&!U0@+FpRL4iK8W6bp!L9Y zG#*Y8UuW_&nIQ-UnYJM}305x0#UN zP@BSA!`p%Z;9X!pF9CkvDRrJ9c4x|jXEzS{M{M5rIp90=a;}rr8|Rg!PRi5)jz!*mAG`O~51tKtKlFJlg~ovBeH*>h?|_u?8_hMaeH{Wv z;|3pq?)UzMpnhrZf!NEy8p=oCY4erCXPXV-dqKE)E7P)n3 z57``HZeNXjI!NW65SL_P%pdDu$MmkGuaHb=Ut+(4{SJ}5Mxm6ruJL;gyc#(6+26lI zTi83rz8ByI!Jd!t?@k@F;pjqk?PR}acUr*IQP70KBGJS8=&rm$|UW?c@OTr*~_|s^E&Syj@>yp z#W-ZYS2-V}|7O5df%SC;?vtL4T?;!W+YK^y_o54cV;1#Y8QhtOaZl(8Mq$4d?h5>S zj?ciHaV7XSKF8C2e+~E$Tgy;KU~Jm}-xVAqzeji;8VBD9JMU|O@Oz2(G6vmwJrU&n zc7VMGG4H`%KY|m0e>1XwO~6z5-RIq#KS1~F@hIS*MjJ0|&gT~3XfO~shDQd!jPA4Y zJCl3WGUP76+-#ffG3K{=z_EyaH$!%wxyBun0qDin6}IO1K7}3sxlr`m73_0<46Fv{ z0ne;EV!s^z2~K^x%;~G|q}ktS+OK=OMLdQy5LnXBUvB1bKE?$4mh4If*-jnw(nuDks$1Y zuAkTOEr*W^@#wvP=WySd3+^rYi1AG3`M~vRU8%lXC$`V=Jq4WmHPN32{|W5{#@7J* zVE56>LVWD&h|O{K{wBb#hvndN^kVM@aT(`}bNy-9XXBEj(jKZSryy2u-C_a8|?b)7Pr?8{RiN)xggp9*nbeQ_u-of&j5FTeRJc~ ziD?Xmf{%!CJbnf@BNyvST=!o1z1%OtdLDx8zST2d8`!H6Z%mK4j-${$gIH!@filh| zpRdTSX^#s^zI4)wwZ62Ant-ShLs z1{-niH_^U|Tpf8=*gkxW99_uv=Oxf4l*`BX{T;=;xfD73TL=2iU_Q3RV3Xf0h-nQL zQO13LXuh_z5z`h-1}77DD!2!Pyn;EJFLSZ^97@bfaeaQ9SVZgxAhkBoZw9Mvt5AP} zotTi%%@Ljni{%t-?Q943thoaDXE=MIuLKu?h8SJHhl3+R8~K>n^ML#6uv|Z7cf;-) zodBZ$1LVdebz-LzXRf#tO3hbv_ve2B?=O3y{scY(j#ctEU!RTdX$L3UNXqzX6Z0Z4 zZ{&SnAZ8Rk=T?_w*?clFHvs!@?#JMVq@EX{uYoVH@0zbIZTOBS zW))oQci>P4UlU?J1wQxGn1-0Z_&WppKMxA$pBl)+fqUa@crolV^?D_gO)~Zt#F&Sl z2YJ7zXa}ApJSQ|wmQTvm<@&xDILG|nRPY}35#zq(nrWY`Cs&SR^Pb1?T?x$lBj6~X zC(C1VfA#EYj`|x&J-cMAGI8c2$HHgT59EEPFc#l^z-KT-y{s2SccSbZ;M_khw>&oY z)*<@AB=qPVA~!BqkL&%IGVW0Y*8;u{#6;(#+&W65Q??JVZ?=`nhnA=Q9$*FVJh;ho zYqCw^eHXJ{-y3{?%D0EQx6UBOwc06Jep52>&I`{w=GSwR@z~wxdc)>i&zdch{?f>l z@!iLFZO`rIq`@HdK89}I9*+MP@B(t`{iCFIi0w=n$9^`5&fmr(*TQ!tybQdHd>|-s z&KGLOa-fKM-T;opWH_6*Er)G)Y@Y$o%&GUkLiG~s`+(2Zwck0!Sr_ok?08H;-sD*z zlr4#=s}>jw%s1{IXMsl4AHAa>Ux926c@R!LquhG&d;T2>jDG;s2Tg%{@ls&@zMF4y z56!K+B%S(dg5F>%^{)bNAYTq#!`s7e!p^f2zoX#ytoRN13VDBUCYXipTr%(d1-)S2 zE~$^D@lkgj+W?-s)&swzbOddY9Y5c<3++RWweJLueJ|KGumrd_yVi>3pwjfIJTbKA z+VDN#F?a&(oW2&UMSm8g<`H@|FdDye+xf8#@Od6mp7txM4DFkznt&Sgs}b-$)3t8C zigGSo727c2y-fsp->oXDPn%N@eREG;0DS*F0{EOfxBZCC?^$`jwQo+F6 + + + + + + + Snipcode API + + + + + + + + +
+
+
+

Snipcode API

+
+ +
+ GraphQL Playground + + Web Application + GitHub Repo +
+
+
+ + + diff --git a/apps/backend/src/features/app/app.controller.ts b/apps/backend/src/features/app/app.controller.ts deleted file mode 100644 index 83771475..00000000 --- a/apps/backend/src/features/app/app.controller.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { Controller, Get } from '@nestjs/common'; - -@Controller() -export class AppController { - constructor() {} - - @Get() - async helloWorld(): Promise { - return 'Hello from Snipcode!'; - } -} diff --git a/apps/backend/src/features/app/app.integration.spec.ts b/apps/backend/src/features/app/app.integration.spec.ts index d38448bb..b25ebcfe 100644 --- a/apps/backend/src/features/app/app.integration.spec.ts +++ b/apps/backend/src/features/app/app.integration.spec.ts @@ -17,6 +17,6 @@ describe('Application Common Endpoints', () => { const response = await request(server.app.getHttpServer()).get('/').expect(200); expect(response.body).toEqual({}); - expect(response.text).toBe('Hello from Snipcode!'); + expect(response.text).toBeDefined(); }); }); diff --git a/apps/backend/src/main.ts b/apps/backend/src/main.ts index 8507fd67..21646035 100644 --- a/apps/backend/src/main.ts +++ b/apps/backend/src/main.ts @@ -17,7 +17,7 @@ const bootstrap = async () => { const host = configService.get('HOST'); await app.listen(port, () => { - logger.log(`Application ready at ${host}:${port}/graphql`); + logger.log(`Application ready at ${host}:${port}`); }); }; diff --git a/apps/backend/tsconfig.json b/apps/backend/tsconfig.json index 23e86132..3a172d78 100644 --- a/apps/backend/tsconfig.json +++ b/apps/backend/tsconfig.json @@ -15,6 +15,7 @@ "./scripts/**/*" ], "exclude": [ + "dist", "node_modules", ".turbo" ], diff --git a/package.json b/package.json index 4a8f1b1d..47e8c4e3 100644 --- a/package.json +++ b/package.json @@ -67,5 +67,5 @@ "turbo": "2.0.5", "typescript": "5.5.2" }, - "packageManager": "yarn@4.3.1" + "packageManager": "yarn@4.4.0" } diff --git a/yarn.lock b/yarn.lock index 35089159..b1687cd3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3878,6 +3878,28 @@ __metadata: languageName: node linkType: hard +"@nestjs/serve-static@npm:4.0.2": + version: 4.0.2 + resolution: "@nestjs/serve-static@npm:4.0.2" + dependencies: + path-to-regexp: "npm:0.2.5" + peerDependencies: + "@fastify/static": ^6.5.0 || ^7.0.0 + "@nestjs/common": ^9.0.0 || ^10.0.0 + "@nestjs/core": ^9.0.0 || ^10.0.0 + express: ^4.18.1 + fastify: ^4.7.0 + peerDependenciesMeta: + "@fastify/static": + optional: true + express: + optional: true + fastify: + optional: true + checksum: 10/337905afb5545ef7280ed408e8929aa4ab7ecf754e11d0c4a7b3e641b50cd34ed9bdd70e16c19f01fb1446a17cd6098481db6de2719c808a43031fdcd8792ac8 + languageName: node + linkType: hard + "@nestjs/testing@npm:10.3.9": version: 10.3.9 resolution: "@nestjs/testing@npm:10.3.9" @@ -5392,6 +5414,7 @@ __metadata: "@nestjs/graphql": "npm:12.1.1" "@nestjs/platform-express": "npm:10.3.9" "@nestjs/schematics": "npm:10.1.1" + "@nestjs/serve-static": "npm:4.0.2" "@nestjs/testing": "npm:10.3.9" "@ngneat/falso": "npm:7.2.0" "@prisma/client": "npm:5.14.0" @@ -15025,6 +15048,13 @@ __metadata: languageName: node linkType: hard +"path-to-regexp@npm:0.2.5": + version: 0.2.5 + resolution: "path-to-regexp@npm:0.2.5" + checksum: 10/9652fd2b74ec932a0df8a868478478565da81e7445a8dde1e65ca80553ad03062336b1f79234068551ecc01f3b76ad774e34f784cc3a34a97c4646cb5cfcbea9 + languageName: node + linkType: hard + "path-to-regexp@npm:2.2.1": version: 2.2.1 resolution: "path-to-regexp@npm:2.2.1"