Portfolio - v3 Monorepo Over Heaven

TODO

• Define the content of the portfolio
• Reproduce existing portfolio or re-start from zero ? Make pros and cons
• Look at wasm-bindgen
• For future Multiplayer game, look at Web-RTC and matchbox and extreme-bevy

Archi

• [DONE] Create a local plugin
  • Create a true Rust Lint command that will integrate what's in cog.toml
  • Create a true Vue Lint command that will extend the front:lint
• [DONE] Change GitHooks to include all the project lint/check
  • Lint should be applied before commit
  • GitLeaks should block commit
  • Test should block if error and display a warn if warning
• Create a CI/CD that will trigger subsequent task depending on the code change (If possible in tekton and if not in github)
  • [DONE] If front change
    • Build in it's own container (nginx)
    • Redeploy container (Helm chart)
    • [TODO] Lighthouse scann
    • [TODO] Sonar scann
  • [DONE] If back change
    • Build in it's own container (including all bin ? follow the Dockerfile from Sandbox bot discord)
    • Redeploy container (Helm chart with every sub component)
    • Go though a different linting process (cargo fmt, cargo clippy, cargo test)
  • Translate github ci workflow
• Create a doc regarding the good practice that should be followed in order to work on this project

Front

• Discover ThreeJS for vue
• Include Vue Router
• Include Pinia if needed
• Include dotenv

Back

• BootStrap tracing based on DiscordBot Sandbox (Set up a lib ?)
• Set up api
  • Utoipa + UI
  • Actix
  • A database ?
  • Include dotenv
• DDD based on sub-lib ?

Game ?

• https://cbournhonesque.github.io/lightyear/book/tutorial/setup.html
• https://github.com/naia-lib/naia

Objectif ? faire un mini jeu multijoueur voir possiblement juste le pong en multi

Idea

Milestone

• [BACK] Start the project [2024-07-14]
• [BACK] First version of the base content [2024-08-05]
• [BACK] Create a SWAGGER API [2024-08-11]
  • [BACK] Serve the home content [2024-08-11]
  • [BACK] Serve the different blog/project/doc content [2024-08-11]
  • [BACK] Serve the media content [2024-08-11]
• [FRONT] Generate api call from swagger
• [FRONT] Render the home page
• [FRONT] Render the blog page and timeline
• [FRONT] Render the doc page

Keeping the same layout

Pros - layout

• The layout is already done
• The layout is already responsive
• I can focus on the improvement of the content
• I can focus on the improvement of the performance
• I can focus on the improvement of the SEO
• I can focus on the future Easter Egg

Cons - layout

• The layout is not perfect
• I have no inspiration to improve the layout/content
• I'm thinking about a new kind of layout
  • Include some basic information about me
  • Include some animation for the Timeline for example
  • Include an "easter egg" that will redirect to a 3D version of the portfolio
  • Include a true blog section
  • Include a true project section

Portfolio base content

• Home
  • Presentation
    • Me ?
    • History ?
  • CV
  • Project
    • Tech that i've used and use
    • Project that i've done using those tech (Linked to blog and Doc)
    • Project that i'm working on (Linked to blog and Doc)
    • Future project (Linked to the WIP page blog and Doc)
  • Contact and Social
• Blog
  • Discovery
  • Tutorial
  • Project (linked to the project section)
  • Editorial/Event
• Doc
  • Link to other doc (like the one for each project) with disclaimer
  • Doc page that in reality is a blog post
• Easter Egg (either ThreeJS or Bevy or vanillaVue JS or Gif)
  • 3D version of the portfolio (Little game ?)
  • Pong game
  • Konami code
  • 418 page, i'm a teapot
  • LEEROYYY JENKINS
  • Rick Roll
  • The cake is a lie
  • The matrix (code, bullet time, rain)
  • Star Wars opening with the text "A long time ago in a galaxy far, far away...."
  • Star Wars BB-8/RD-D2 (little droid that will follow the mouse or run through the base of the page)
  • Iron Man (Jarvis ?)
  • The Avengers (Thanos snap ?)
  • Thor (Mjolnir ?)
  • The Hulk (Always angry ?)
  • H2G2 (Don't panic take a towel, 42, "the answer to the ultimate question of life, the universe, and everything" , the wale and the petunia)
  • Jojo (To be continued, the pose, No No No, Yes Yes Yes)
  • Pokemon (Pikachu, Charmander, Bulbasaur, Squirtle, One day i'll be the best)
  • Zelda ("It's dangerous to go alone, take this", the triforce, the master sword, the ocarina, im not zelda but a link)
  • Gundam

Doc and Blog article should be in the markdown format

Participating

Install Hook

cog install-hook --all

Generate code coverage

cargo llvm-cov --workspace --open

Tool needed

• Rust => Backend runtime
• NodeJS => Frontend runtime
• Yarn => Package manager
• GitLeaks => Git security
• Rust - Clippy => Code security/quality
• Rust - Rustfmt => Code formatting
• Rust - cargo-llvm => Code coverage
• Rust - bump => Bump version
• Git => Version control (obviously)
• Cocogitto => Git hooks and conventional commit

Create new rust lib

nx generate @monodon/rust:library <lib-name>

Nx - Front

Start the application

Run npx nx serve front to start the development server. Happy coding!

Build for production

Run npx nx build front to build the application. The build artifacts are stored in the output directory (e.g. dist/ or build/), ready to be deployed.

Running tasks

To execute tasks with Nx use the following syntax:

npx nx <target> <project> <...options>

You can also run multiple targets:

npx nx run-many -t <target1> <target2>

..or add -p to filter specific projects

npx nx run-many -t <target1> <target2> -p <proj1> <proj2>

Targets can be defined in the package.json or projects.json. Learn more in the docs.

Set up CI

Nx comes with local caching already built-in (check your nx.json). On CI you might want to go a step further.

• Set up remote caching
• Set up task distribution across multiple machines
• Learn more how to setup CI

Explore the project graph

Run npx nx graph to show the graph of the workspace. It will show tasks that you can run with Nx.

• Learn more about Exploring the Project Graph