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 »

Table of Contents

1. About The Project
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. Contacts

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 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 to obtain both of them:

# 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:

   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:

   npm ci
   

Usage

In the project directory, you can run:

• npm start

  Runs the app in the development mode.
  Open http://localhost:5173 to view it in the browser.

  The page will reload if you make edits.
  You will also see any lint errors in the console.

• npm run test

  Launches the test runner in the interactive watch mode.
  See the section about running tests for more information.

• npm run test:coverage

  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 for more information.

• npm run serve

  Preview the app in the production mode.
  Open http://localhost:4173 to view it in the browser.

Roadmap

See the open issues for a list of proposed features (and known issues). See the Roadmap kanban 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 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

Project Link: Github