mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-27 09:15:10 +00:00
deleting junk files
This commit is contained in:
David DuChene
parent
fcf18ca709
commit
988af3fd3c
4 changed files with 0 additions and 233 deletions
|
|
@ -1,76 +0,0 @@
|
||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as
|
|
||||||
contributors and maintainers pledge to making participation in our project and
|
|
||||||
our community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, 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.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment
|
|
||||||
include:
|
|
||||||
|
|
||||||
- Using welcoming and inclusive language
|
|
||||||
- Being respectful of differing viewpoints and experiences
|
|
||||||
- Gracefully accepting constructive criticism
|
|
||||||
- Focusing on what is best for the community
|
|
||||||
- Showing empathy towards other community members
|
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
|
||||||
|
|
||||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
|
||||||
advances
|
|
||||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
|
||||||
- Public or private harassment
|
|
||||||
- Publishing others' private information, such as a physical or electronic
|
|
||||||
address, without explicit permission
|
|
||||||
- Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Our Responsibilities
|
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
|
||||||
response to any instances of unacceptable behavior.
|
|
||||||
|
|
||||||
Project maintainers 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, or to ban temporarily or
|
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
|
||||||
threatening, offensive, or harmful.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces
|
|
||||||
when an individual is representing the project or its community. Examples of
|
|
||||||
representing a project or community include using an official project e-mail
|
|
||||||
address, posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event. Representation of a project may be
|
|
||||||
further defined and clarified by project maintainers.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported by contacting the project team at hello@frappe.io. All
|
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
|
||||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
||||||
Further details of specific enforcement policies may be posted separately.
|
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
||||||
faith may face temporary or permanent repercussions as determined by other
|
|
||||||
members of the project's leadership.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
||||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see
|
|
||||||
https://www.contributor-covenant.org/faq
|
|
||||||
|
|
@ -1,76 +0,0 @@
|
||||||
# Contribution Guidelines
|
|
||||||
|
|
||||||
Before publishing a PR, please test builds locally.
|
|
||||||
|
|
||||||
On each PR that contains changes relevant to Docker builds, images are being built and tested in our CI (GitHub Actions).
|
|
||||||
|
|
||||||
> :evergreen_tree: Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images uses energy and contributes to global warming.
|
|
||||||
|
|
||||||
## Lint
|
|
||||||
|
|
||||||
We use `pre-commit` framework to lint the codebase before committing.
|
|
||||||
First, you need to install pre-commit with pip:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pip install pre-commit
|
|
||||||
```
|
|
||||||
|
|
||||||
Also you can use brew if you're on Mac:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
brew install pre-commit
|
|
||||||
```
|
|
||||||
|
|
||||||
To setup _pre-commit_ hook, run:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pre-commit install
|
|
||||||
```
|
|
||||||
|
|
||||||
To run all the files in repository, run:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pre-commit run --all-files
|
|
||||||
```
|
|
||||||
|
|
||||||
## Build
|
|
||||||
|
|
||||||
We use [Docker Buildx Bake](https://docs.docker.com/engine/reference/commandline/buildx_bake/). To build the images, run command below:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
FRAPPE_VERSION=... ERPNEXT_VERSION=... docker buildx bake <targets>
|
|
||||||
```
|
|
||||||
|
|
||||||
Available targets can be found in `docker-bake.hcl`.
|
|
||||||
|
|
||||||
## Test
|
|
||||||
|
|
||||||
We use [pytest](https://pytest.org) for our integration tests.
|
|
||||||
|
|
||||||
Install Python test requirements:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
python3 -m venv venv
|
|
||||||
source venv/bin/activate
|
|
||||||
pip install -r requirements-test.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
Run pytest:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
pytest
|
|
||||||
```
|
|
||||||
|
|
||||||
> We also have `requirements-dev.txt` file that contains development requirements for backend image (you can find it in `images/worker/` directory).
|
|
||||||
|
|
||||||
# Documentation
|
|
||||||
|
|
||||||
Place relevant markdown files in the `docs` directory and index them in README.md located at the root of repo.
|
|
||||||
|
|
||||||
# Wiki
|
|
||||||
|
|
||||||
Add alternatives that can be used optionally along with frappe_docker. Add articles to list on home page as well.
|
|
||||||
|
|
||||||
# Frappe and ERPNext updates
|
|
||||||
|
|
||||||
Each Frappe/ERPNext release triggers new stable images builds as well as bump to helm chart.
|
|
||||||
21
LICENSE
21
LICENSE
|
|
@ -1,21 +0,0 @@
|
||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2017 Frappe Technologies Pvt. Ltd.
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
60
README.md
60
README.md
|
|
@ -1,60 +0,0 @@
|
||||||
[](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
|
|
||||||
[](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)
|
|
||||||
|
|
||||||
Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https://github.com/frappe/erpnext) in containers.
|
|
||||||
|
|
||||||
# Getting Started
|
|
||||||
|
|
||||||
To get started, you need Docker, docker-compose and git setup on your machine. For Docker basics and best practices. Refer Docker [documentation](http://docs.docker.com).
|
|
||||||
After that, clone this repo:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git clone https://github.com/frappe/frappe_docker
|
|
||||||
cd frappe_docker
|
|
||||||
```
|
|
||||||
|
|
||||||
### Try in Play With Docker
|
|
||||||
|
|
||||||
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">
|
|
||||||
<img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
Wait for 5 minutes for ERPNext site to be created or check `create-site` container logs before opening browser on port 8080. (username: `Administrator`, password: `admin`)
|
|
||||||
|
|
||||||
# Development
|
|
||||||
|
|
||||||
We have baseline for developing in VSCode devcontainer with [frappe/bench](https://github.com/frappe/bench). [Start development](development).
|
|
||||||
|
|
||||||
# Production
|
|
||||||
|
|
||||||
We provide simple and intuitive production setup with prebuilt Frappe and ERPNext images and compose files. To learn more about those, [read the docs](docs/images-and-compose-files.md).
|
|
||||||
|
|
||||||
Also, there's docs to help with deployment:
|
|
||||||
|
|
||||||
- Examples:
|
|
||||||
- [Single Server](docs/single-server-example.md)
|
|
||||||
- [Setup options](docs/setup-options.md)
|
|
||||||
- [Kubernetes (frappe/helm)](https://helm.erpnext.com)
|
|
||||||
- [Site operations](docs/site-operations.md).
|
|
||||||
- Other
|
|
||||||
- [backup and push cron jobs](docs/backup-and-push-cronjob.md)
|
|
||||||
- [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)
|
|
||||||
- [build version 10](docs/build-version-10-images.md)
|
|
||||||
- [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
|
|
||||||
- [patch code from images](docs/patch-code-from-images.md)
|
|
||||||
- [port based multi tenancy](docs/port-based-multi-tenancy.md)
|
|
||||||
- [Troubleshoot](docs/troubleshoot.md)
|
|
||||||
|
|
||||||
# Custom app
|
|
||||||
|
|
||||||
Learn how to containerize your custom Frappe app(s) in [this guide](custom_app/README.md).
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
||||||
|
|
||||||
This repository is only for Docker related stuff. You also might want to contribute to:
|
|
||||||
|
|
||||||
- [Frappe framework](https://github.com/frappe/frappe#contributing),
|
|
||||||
- [ERPNext](https://github.com/frappe/erpnext#contributing),
|
|
||||||
- or [Frappe Bench](https://github.com/frappe/bench).
|
|
||||||
Loading…
Reference in a new issue