SnowTricks

Description

SnowTricks is a collaborative site aimed at raising public awareness about the sport and assisting in the learning of tricks.

Sommaire

• Description
• Installation
• Configuration
• Database
• Usage
• Documentation

Installation

1. Clone the repository:

   git clone https://github.com/meline-p/snowtricks.git

2. Navigate to the project directory:

   cd snowtricks

3. Install dependencies with Composer:

   composer install

4. Configure the environment by copying the .env file:

   cp .env .env.local

5. Install MailDev with npm: MailDev installation : https://github.com/maildev/maildev

   npm install -g maildev

Configuration

• APP_SECRET : Generate a random secret key

  php bin/console secrets:generate-keys

• DATABASE_URL : Database connection URL.
• MAILER_DSN : Mail service URL.
• JWT_SECRET : Secret key for JWT Service

Ensure these parameters are configured in the .env.local file.

Database

1. Update the database:

   php bin/console doctrine:migrations:migrate

2. (Optional) Load test data:

   php bin/console doctrine:fixtures:load

Usage

Terminal 1 : Launch the website

Start the local server:

symfony serve -d

Access the application via your browser at http://localhost:8000.

Terminal 2 : Launch MailDev

maildev

Access the MailDev interface at http://localhost:1080/.

Documentation

To generate documentation, use phpDocumentor. You can download the latest PHAR file from https://phpdoc.org/phpDocumentor.phar and put it at the root of the project. Execute this command:

php phpDocumentor.phar run -d ./src -t docs/

Access the generated documentation in the docs/index.html directory. Launch Go Live on Visual Studio Code and access the online documentation in the docs directory.