From 9380dfe8b5065c6b9ccc4d6c95db89accf34c6ea Mon Sep 17 00:00:00 2001 From: m-tartari <37861893+m-tartari@users.noreply.github.com> Date: Tue, 17 Feb 2026 12:08:31 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20create=20a=20proper=20RE?= =?UTF-8?q?ADME=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/build.yml | 8 +- .github/workflows/deploy.yml | 4 +- .github/workflows/release.yml | 2 +- README.md | 270 +++++++++++++++++++++++++++++----- 4 files changed, 237 insertions(+), 47 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8fe6cbd..4c26963 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,7 +1,7 @@ -name: build +name: Build on: push: - branches: ['main'] + branches: ["main"] pull_request: {} workflow_call: {} workflow_dispatch: {} @@ -16,8 +16,8 @@ jobs: - uses: actions/setup-node@v6 with: - node-version: 'lts/*' - cache: 'npm' + node-version: "lts/*" + cache: "npm" - name: Install production dependencies run: npm ci --omit=dev diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 474adfa..2187e3e 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,5 +1,5 @@ -# Simple workflow for deploying static content to GitHub Pages -name: deploy +# Simple workflow for deploying static content to Cloudflare Pages +name: Deployment (Staging) on: # Runs on pushes targeting the default branch diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2b94ba7..0e0668a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,5 +1,5 @@ # Simple workflow for deploying static content to GitHub Pages -name: deploy +name: Deployment (Production) on: # Trigger the workflow on release publish events diff --git a/README.md b/README.md index 1bb8390..a68f9b1 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,247 @@ -

Hi there, I'm Michele - aka m-tartari 👋

-

A Robotics/Full-Stack Engineer from Italy

-
+ + + + + +
+

+ + Logo + + +

Compagnia d'Arme del Santo Luca Website

+ +

+ Ass. di rievocazione storica affiliata C.E.R.S. (XIV-XV secolo) +
+ Contact us + · + Request Feature + · + Report Bug +
+ Explore the docs » +

+

+ + + +[![Deployment (Prod) Status](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/actions/workflows/release.yml/badge.svg)](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/actions/workflows/release.yml) +[![Deployment (Staging) Status](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/actions/workflows/deploy.yml/badge.svg)](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/actions/workflows/deploy.yml) +[![Build Status](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/actions/workflows/build.yml/badge.svg)](./.github/workflows/build.yml) + + + + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. + +
  4. Roadmap
    5. +
  5. Contributing
    6. + +
  6. Contacts
    7. + +
+
+ + + +## About The Project + +This is where we develop Compagnia d'Arme del Santo Luca's website. + +## Getting Started + +There are two ways to run the project: using a devcontainer or running it locally. We recommend using the devcontainer, as it ensures that the project runs in a consistent environment. + +### Devcontainer + +The project is configured to run in a devcontainer. To use it, you need to have Docker and Visual Studio Code installed. + +1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for Visual Studio Code. +2. Open the project in Visual Studio Code. +3. Click on the green icon in the bottom left corner of the window. +4. Select "Reopen in Container". + +### Local + +To get a local copy up and running follow these simple example steps. + +#### Prerequisites + +We only support the latest lts version of Node and npm. + +You can use [`nvm`](https://github.com/nvm-sh/nvm) to obtain both of them: + +```bash +# install the lastest version of nvm +release_url=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/nvm-sh/nvm/releases/latest) +release_tag=$(basename $release_url) +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/$release_tag/install.sh | bash +unset release_url release_tag +source ~/.bashrc + +# use nvm to install latest lts version of node and npm +nvm install --lts +``` + +#### Installation + +Few steps are required to be up and running: + +1. clone the repository: + + ```bash + git clone git@github.com:Compagnia-d-Arme-del-Santo-Luca/website.git + cd website + ``` + +2. Install the dependencies in the local node_modules folder: + + ```bash + npm ci + ``` + +## Usage + +In the project directory, you can run: + +- `npm start` + + Runs the app in the development mode.\ + Open to view it in the browser. + + The page will reload if you make edits.\ + You will also see any lint errors in the console. -### Languages and Tools: +- `npm run test` -[typescript](https://www.typescriptlang.org/) -[javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) -[python](https://www.python.org) -[cplusplus](https://www.w3schools.com/cpp/) -[c](https://www.cprogramming.com/) -[bash](https://www.gnu.org/software/bash/) + Launches the test runner in the interactive watch mode.\ + See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - +- `npm run test:coverage` -[react](https://reactjs.org/) -[jest](https://jestjs.io) -[flask](https://flask.palletsprojects.com/) -[express](https://expressjs.com) + Launches the test runner with coverage report. + +- `npm run build` + + Builds the app for production to the `build` folder.\ + It correctly bundles React in production mode and optimizes the build for the best performance. + + The build is minified and the filenames include the hashes.\ + Your app is ready to be deployed! + + See the section about [deployment](https://vitejs.dev/guide/static-deploy) for more information. - +- `npm run build:storybook` -[github-actions](https://github.com/features/actions) -[travisci](https://travis-ci.org) -[docker](https://www.docker.com/) + Builds Storybook as a static web application. +--> + +- `npm run serve` + + Preview the app in the production mode.\ + Open to view it in the browser. - - -[matlab](https://www.mathworks.com/) -[arduino](https://www.arduino.cc/) -[ROS](https://www.ros.org/) + + +## Roadmap + +See the [open issues](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website/issues) for a list of proposed features (and known issues). See the [Roadmap kanban](https://github.com/orgs/Compagnia-d-Arme-del-Santo-Luca/projects/1) for the state of the development. + + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +**IMPORTANT:** If you beleve you've found a security vulnerabilities, please follow our [Security Policy](./SECURITY.md) and **do not** report it through public GitHub issues and PRs. + +For all other contributions: + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feat/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feat/AmazingFeature`) +5. Open a Pull Request + + + + + +## Contacts + +Compagnia d'Arme del Santo Luca - [compagniasantoluca@gmail.com](mailto:compagniasantoluca@gmail.com) + +Project Link: [Github](https://github.com/Compagnia-d-Arme-del-Santo-Luca/website) + + + + + + - -### Contact me with: - -[github](https://github.com/m-tartari) -[linkedin](https://linkedin.com/in/m-tartari)