mirror of
https://github.com/symfony/ux.symfony.com.git
synced 2026-03-24 00:02:09 +01:00
Adapt .md files
This commit is contained in:
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -7,13 +7,4 @@
|
||||
|
||||
<!--
|
||||
Replace this notice by a description of your feature/bugfix.
|
||||
This will help reviewers and should be a good start for the documentation.
|
||||
|
||||
Additionally (see https://symfony.com/releases):
|
||||
- Always add tests and ensure they pass.
|
||||
- For new features, provide some code snippets to help understand usage.
|
||||
- Features and deprecations must be submitted against branch main.
|
||||
- Update/add documentation as required (we can help!)
|
||||
- Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
|
||||
- Never break backward compatibility (see https://symfony.com/bc).
|
||||
-->
|
||||
|
||||
18
CONTRIBUTING.md
Normal file
18
CONTRIBUTING.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for considering contributing to the Symfony UX website!
|
||||
|
||||
The ux.symfony.com website is an open source, community-driven project, and we are happy to receive contributions from the community!
|
||||
|
||||
> [!TIP]
|
||||
> It's a good idea to read the [Symfony's Contribution Guide](https://symfony.com/doc/current/contributing/index.html) first
|
||||
|
||||
## Reporting an issue
|
||||
|
||||
If you find a bug on the website, have a feature request, or need help/have a question, please [open an issue](https://github.com/symfony/ux.symfony.com/issues/new).
|
||||
|
||||
For issues related to the Symfony UX packages themselves (not the website), please use [the symfony/ux repository](https://github.com/symfony/ux/issues/new/choose) instead.
|
||||
|
||||
Please provide as much information as possible, and remember to follow our
|
||||
[Code of Conduct](https://symfony.com/doc/current/contributing/code_of_conduct/index.html)
|
||||
to ensure a friendly environment for all contributors.
|
||||
62
README.md
62
README.md
@@ -1,27 +1,50 @@
|
||||
# [ux.symfony.com](https://ux.symfony.com)
|
||||
# ux.symfony.com
|
||||
|
||||
Source code for [ux.symfony.com](https://ux.symfony.com).
|
||||
|
||||
## Installation
|
||||
|
||||
### Source code
|
||||
### Forking the repository
|
||||
|
||||
Install the project:
|
||||
```bash
|
||||
git clone git@github.com:symfony/ux
|
||||
cd ux/ux.symfony.com/
|
||||
To contribute to the website, you need to [fork the **symfony/ux.symfony.com** repository](https://github.com/symfony/ux.symfony.com/fork) on GitHub.
|
||||
This will give you a copy of the code under your GitHub user account. Read [the documentation "How to fork a repository"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
|
||||
|
||||
After forking the repository, you can clone it to your local machine:
|
||||
|
||||
```shell
|
||||
# Using GitHub CLI https://cli.github.com/
|
||||
$ gh repo clone <USERNAME>/ux.symfony.com ux.symfony.com
|
||||
|
||||
# Using SSH
|
||||
$ git clone git@github.com:<USERNAME>/ux.symfony.com.git ux.symfony.com
|
||||
$ cd ux.symfony.com
|
||||
# Add the upstream repository, to keep your fork up-to-date
|
||||
$ git remote add upstream git@github.com:symfony/ux.symfony.com.git
|
||||
```
|
||||
|
||||
Install the dependencies:
|
||||
```bash
|
||||
### Setting up the development environment
|
||||
|
||||
To set up the development environment, you need the following tools:
|
||||
|
||||
- **[PHP](https://www.php.net/downloads.php) 8.5 or higher** - Required for running the Symfony application
|
||||
- **[Composer](https://getcomposer.org/download/)** - PHP dependency manager
|
||||
- **[Symfony CLI](https://symfony.com/download)** - Recommended for running the development server
|
||||
- **[Docker](https://www.docker.com/)** - For running services (database, etc.)
|
||||
|
||||
With these tools installed, you can install the project dependencies:
|
||||
|
||||
```shell
|
||||
# Install PHP dependencies
|
||||
symfony composer install
|
||||
```
|
||||
|
||||
### Services
|
||||
### Running the website locally
|
||||
|
||||
(optional) Configure Docker to launch Mercure
|
||||
```bash
|
||||
docker compose up -d
|
||||
To run the website in local development:
|
||||
|
||||
```shell
|
||||
symfony serve --open
|
||||
# The website will be accessible at https://127.0.0.1:9044/
|
||||
```
|
||||
|
||||
### Database
|
||||
@@ -43,21 +66,6 @@ Download the importmap packages locally:
|
||||
symfony console importmap:install
|
||||
```
|
||||
|
||||
Compile the Sass files:
|
||||
```bash
|
||||
symfony console sass:build
|
||||
|
||||
# (optional) Add the --watch flag to automatically recompile the Sass files on change.
|
||||
symfony console sass:build --watch
|
||||
```
|
||||
|
||||
### Local server
|
||||
|
||||
Start the local web server (in background):
|
||||
```bash
|
||||
symfony server:start -d
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user