Commit 7d91c21c authored by Fabrice Gangler's avatar Fabrice Gangler 🎨
Browse files

DOC: improve documentation

Refs: #26
parent 9f0666e3
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at [https://adullact.org/contact](https://adullact.org/contact).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
# Contributing
First off, thanks for taking the time to contribute!
## How Can I Contribute?
- Reporting bugs
- Suggesting enhancements
- Code contribution
## Styleguides
- [Git Commit message](documentation/30_Contributor_doc/GIT_CONVENTION.md)
## Sources of inspiration for CONTRIBUTING.md
* For contributors doc [Gitlab Workflow](https://about.gitlab.com/handbook/#gitlab-workflow)
* [Atom's Contributing file](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) that is really good and brightly written.
......@@ -4,12 +4,28 @@ You should have already [check pre-requisites](webapp_Pre-requisites.md).
## Ubuntu 18.04
### Grab source code
```bash
# Grab source code and installing dependencies
git clone git@gitlab.adullact.net:Comptoir/comptoir.git
cd comptoir/webapp/
composer install
```
### Starting a local web server (not use it for production)
- **not use** it for **production**
- only for dev and test environnemnets
# Starting a web server (not ready for production)
```bash
# via PHP (not use it for production)
cd webapp/
php -S 127.0.0.1:8383 -t public/
# via Symfony CLI (not use it for production)
cd webapp/
symfony serve
```
We recommend you to use the **Symfony CLI** option for a development environment
and you can consult our [memento](../90_Mementos/memento_Symfony-CLI.md) to understand how to use it.
# Prerequisites for web application installation
# Prerequisites for web application installation
## Prerequesites
......@@ -82,7 +82,8 @@ composer check-platform-reqs
### Optional
Download `composer` packages in parallel:
#### Download `composer` packages in parallel
- [hirak/prestissimo](https://packagist.org/packages/hirak/prestissimo), a composer plugin that downloads packages in parallel
- `hirak/prestissimo` must be installed globaled for the user who launch `composer install` command.
......@@ -93,3 +94,14 @@ composer global require hirak/prestissimo
php -v
sudo apt -y install php<Major.Minor>-curl
```
#### Symfony CLI tool (dev|test environnemnets)
- not install and **not use** it for **production**
- only for dev and test environnemnets
- start a web server (HTTP or HTTP**S**)
- display server logs and symfony framework logs
To install it you have to follow the [procedure](https://symfony.com/download) in the Symfony documentation.
and consult our [memento](../90_Mementos/memento_Symfony-CLI.md).
......@@ -16,10 +16,22 @@ git clone git@gitlab.adullact.net:Comptoir/comptoir.git
cd comptoir/webapp/
composer install
# Starting a web server (not ready for production)
php -S 127.0.0.1:8383 -t public/
# Starting a local web server
# via PHP (not use it for production)
cd webapp/
php -S 127.0.0.1:8383 -t public/
# via Symfony CLI (not use it for production)
cd webapp/
symfony serve
```
We recommend you to use the **Symfony CLI** option for a development environment
and you can consult our [memento](../90_Mementos/memento_Symfony-CLI.md) to understand how to use it.
## Units tests and Functional tests
- https://symfony.com/doc/current/testing.html
- https://symfony.com/doc/current/testing/database.html
......
# Symfony CLI tool (dev|test environnemnets)
- not install and **not use** it for **production**
- only for dev and test environnemnets
- start a web server (HTTP or HTTP**S**)
- display server logs and symfony framework logs
To install it you have to follow the [procedure](https://symfony.com/download) in the Symfony documentation.
## HTTPS
If you want to use the HTTPS protocol, you need to install the `libnss3-tools` debian package.
```bash
sudo apt install libnss3-tools
symfony server:ca:install # Create a local Certificate Authority for serving HTTPS
```
## Usages (cheatsheet)
```bash
# List available PHP versions
symfony local:php:list # List locally available PHP versions
symfony local:php:refresh # Auto-discover the list of available PHP version
# Create a local Certificate for serving HTTPS
symfony server:ca:install # Create a local Certificate Authority for serving HTTPS
symfony server:ca:uninstall # Uninstall the local Certificate Authority
# Run a local web server
symfony serve # Run a local web server
symfony serve -d # Run a local web server in the background
symfony server:log # Display local web server logs
symfony server:status # Get the local web server status
symfony server:stop # Stop the local web server
symfony server:list # List all running local web servers (launched with command "symfony serve"
symfony server:prod # Switch a project to use Symfony's production environment
symfony server:prod --off # Disable prod mode
# Open in a browser (local website, symfony doc, ...)
symfony open:docs # Open the online Web documentation
symfony open:local # Open the local project in a browser
symfony open:local:rabbitmq # Open the local project RabbitMQ web management interface in a browser
symfony open:local:webmail # Open the local project mail catcher web interface in a browser
# Book "Symfony 5: The Fast Track"
# see: https://github.com/the-fast-track/book-5.0-1
symfony book:check # Check that you have all the pre-requisites locally to code while reading the book
symfony book:checkout # Check out a step of the "Symfony 5: The Fast Track" book repository
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment