Skip to content

Commit ca430e5

Browse files
nelson6e65nelson6e65
committed
chore(docker): setup docker and add instructions
docs: add CONTRIBUTING and CODE_OF_CONDUCT
1 parent 57728ba commit ca430e5

File tree

9 files changed

+323
-0
lines changed

9 files changed

+323
-0
lines changed

‎.docker/7.3/Dockerfile

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
FROM php:7.3-cli
2+
3+
LABEL maintainer="Nelson Martell"
4+
5+
ARG WWWGROUP=1000
6+
ARG NODE_VERSION=16
7+
8+
RUN groupadd --force -g $WWWGROUP docker-user
9+
RUN useradd -ms /bin/bash --no-user-group -g $WWWGROUP -u $WWWGROUP docker-user
10+
11+
RUN apt-get update -y
12+
RUN apt-get install -y git zip unzip
13+
RUN docker-php-ext-install \
14+
mbstring ctype
15+
RUN php -r "readfile('https://getcomposer.org/installer');" | php -- --install-dir=/usr/bin/ --filename=composer
16+
17+
RUN curl -sLS https://deb.nodesource.com/setup_$NODE_VERSION.x | bash - \
18+
&& apt-get install -y nodejs && npm i -g npm
19+
20+
RUN npm install --global http-server
21+
22+
WORKDIR /var/www/html

‎.docker/composer

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
docker compose run -it app composer $@

‎.docker/npm

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
docker compose run -it -p 8080:8080 app npm $@

‎.docker/php

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
docker compose run -it app php $@

‎.docker/phpdoc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
docker compose run -it app vendor/bin/phpdoc $@

‎.github/CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎.github/CONTRIBUTING.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributing Guidelines
2+
3+
Contributions are welcome and will be fully credited.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Code of conduct
8+
9+
Check the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md).
10+
11+
## Viability
12+
13+
When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
14+
15+
## Filling an issue
16+
17+
Before filing an issue:
18+
19+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
20+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
21+
- Check to make sure your feature suggestion isn't already present within the project.
22+
- Check the pull requests tab to ensure that the feature isn't already in progress.
23+
24+
> There are issue templates for bug reports, feature request and questions.
25+
26+
## Creating a pull request
27+
28+
Before submitting a pull request:
29+
30+
- Check the codebase to ensure that your feature doesn't already exist.
31+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
32+
- Check the issues list an relate your PR with an existing one. If there is not any, it may be useful to file a new one.
33+
- Create a new issue asking about implementing your feature if is not an small change.
34+
35+
## Installing locally
36+
37+
### Pre-installing requirements
38+
39+
#### Using Docker
40+
41+
If you don't have / want Composer and PHP installed in your local environment, you can use the configured Docker image for this.
42+
43+
For this, you will need to [install Docker in your computer](https://docs.docker.com/engine/install) and build the image:
44+
45+
```sh
46+
docker compose build
47+
```
48+
49+
The image contains PHP 7.3, Node 16 and npm.
50+
51+
> Then you can run `docker compose run -it app bash` and use `php` and `npm` as usual.
52+
53+
#### Without Docker
54+
55+
If you already have PHP and Node installed, you'll need:
56+
57+
- PHP >= 5.6 <= 7.3
58+
- Node >= 8 <= 16
59+
- npm >= 7
60+
61+
> Is recommended to use [nvm](https://github.com/nvm-sh/nvm) to manage Node versions.
62+
63+
### Installing dependencies
64+
65+
Make sure to install composer and npm dependencies.
66+
67+
```sh
68+
composer install
69+
70+
# Or
71+
# docker compose run -it app composer install
72+
```
73+
74+
```sh
75+
npm install
76+
77+
# Or
78+
# docker compose run -it app npm install
79+
```
80+
81+
> Run `docker compose run -it app bash` to enter interactively to the docker shell.
82+
83+
> You can also run
84+
85+
### Building and previewing
86+
87+
First, start the pre-installed static http server:
88+
89+
```sh
90+
docker compose up -d
91+
```
92+
93+
Extract the PHP API docs:
94+
95+
```sh
96+
# Each time demo files are changed
97+
composer build:api
98+
99+
# or
100+
# docker compose run -it app composer build:api
101+
```
102+
103+
Build the HTML files:
104+
105+
```sh
106+
# After changing any .md file (including the one generated by build:api)
107+
npm run docs:build
108+
109+
# or
110+
# docker compose run -it app npm run docs:build
111+
```
112+
113+
Then, you can navigate to http://127.0.0.1:8089.
114+
115+
For development, auto-refreshing Vue files, use this instead:
116+
117+
```sh
118+
npm run docs:dev
119+
120+
# or
121+
# docker compose run -it -p 8080:8080 app npm run docs:dev
122+
```
123+
124+
> There are some aliases for docker commands under `.docker/` directory:
125+
>
126+
> - php
127+
> - npm
128+
> - composer
129+
> - phpdoc
130+
>
131+
> Example: `.docker/composer install`

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ See the [Configuration section in the documentation](https://nelson6e65.github.i
7979

8080
Check the documentation for more information [https://nelson6e65.github.io/phpdoc-vuepress/](https://nelson6e65.github.io/phpdoc-vuepress/).
8181

82+
## Contributing
83+
84+
Check out the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for details about contributing.
85+
8286
## License
8387

8488
[![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)

‎docker-compose.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version: "3"
2+
services:
3+
app:
4+
user: "${UID:-1000}:${GID:-1000}"
5+
build:
6+
context: ./.docker/7.3
7+
dockerfile: Dockerfile
8+
args:
9+
WWWGROUP: "${UID:-1000}"
10+
networks:
11+
- default
12+
ports:
13+
- "${VUEPRESS_DEV_PORT:-8080}:8080"
14+
- "${VUEPRESS_PORT:-8089}:8089"
15+
volumes:
16+
- "${PWD}:/var/www/html"
17+
- "${COMPOSER_HOME:-$HOME/.config/composer}:${COMPOSER_HOME:-$HOME/.config/composer}"
18+
- "${COMPOSER_CACHE_DIR:-$HOME/.cache/composer}:${COMPOSER_CACHE_DIR:-$HOME/.cache/composer}"
19+
command: http-server dist/phpdoc-vuepress --port 8089 --proxy http://localhost:8089?
20+
networks:
21+
default:
22+
driver: bridge

0 commit comments

Comments
 (0)