https://github.com/batleforc/portfolio-v2

https://github.com/batleforc/portfolio-v2

Last synced: about 18 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/batleforc/portfolio-v2
• Owner: batleforc
• Created: 2024-04-12T18:53:18.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-06T19:42:00.000Z (8 months ago)
• Last Synced: 2024-06-06T21:26:27.765Z (8 months ago)
• Language: Rust
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Portfolio - V2Rust

## Module

This project is split into X module:

- Front: That will include everything related to rendering the frontend app

- Back: That will handle the backend part

- Common : Who will handle the common package shared accross the app

- Driven: Include everything that is driven like a database

- Driving: Well most likely the part that will define the API and or the Actix Actor (well a WS in fact)

## Contributing

Has of now, the best choice for contributing and having a ready to dev env is to use a FullRemote like env based on the image that i provide.

BUT if you need to make your own here what's needed:

- Rust (latest)

- [Cargo-bump](https://crates.io/crates/cargo-bump)

- [Cargo-audit](https://github.com/RustSec/rustsec/tree/main/cargo-audit)

- [Cocogitto](https://github.com/cocogitto/cocogitto)

- [GitLeaks](https://github.com/gitleaks/gitleaks)

Please do `cog install-hook --all` before your first commit, the hooks include a pre commit that will check for any secret and possible clippy error.

## CICD ?

This repo has two CICD:

- Build and Release that will create a release draft on each Tag

- Clippy that will check for possible improvement

### Release

NO TAG SHOULD BE MANUALY MADE !!

To make a tag use :

```shell

cog bump [ --patch | --minor | --major ]

```

Doing it with the cli will:

- Increment the past version depending on the choice made (patch/minor/major)

- Change the version in Cargo.toml

- Generate the changelog

- Trigger the pipeline that will create a draft with possible package

#### If you want to undraft the release

- Go to the [Github release page](https://github.com/batleforc/portfolio-v2/releases)

- Select the release to undraft

- Give it a name like `0.2.2 - Dalek` and a descrption to your need

- Publish the release and enjoy !!