updated README

Author: Muhammad Atif

CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Code of Conduct
+
+In this open-source project, our aim is to foster a welcoming and inclusive environment. We expect all contributors
+and participants interact with each other with courtesy, respect and kindness.
+
+We will not tolerate abuse or harassment of any kind.
+
+In the event of a concern about behaviour, please contact the maintainers of the project:
+
+* Dennis Schwertel <[email protected]>
+
+Reports will be taken seriously and treated in confidence. If necessary, the maintainers will act to exclude
+individuals from participating in this and other projects.
+
+
+## Code review
+
+Code review can be a frustrating process for both contributors and reviewers, with many opportunities for mutual
+misunderstanding.
+
+We expect participants who submit contributions for review to understand and accept that all contributions to the
+project, including code and the ideas behind it, will be reviewed carefully. Often review will include critique and
+criticism, and will almost always require improvements or other changes before contributions can be accepted.
+
+We also expect reviewers to communicate sensitively and respectfully.
+
+This is in line with a shared aim for the success of the project.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# How to contribute to the project
+
+Thanks for contributing, welcome aboard.
+
+Please see our [CODE OF CONDUCT](./CODE_OF_CONDUCT.md) for our code of conduct.
+
+
+## Submitting proposals
+
+Please provide proposals as
+[pull requests](https://github.com/flavours/getting-started-with-spring-boot/pulls)
+or
+[issues](https://github.com/flavours/getting-started-with-spring-boot/issues) as appropriate.
+
+
+## Pull requests and branches
+
+Please make pull requests:
+
+* from an appropriately-named new branch
+* to the ``main`` branch
+
+See:
+
+* [how to make pull requests](https://help.github.com/articles/using-pull-requests/)
+* [how to manage branches](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
+
+
+### Whitespace
+
+Do not use trailing whitespace (spaces or tabs at the end of a line). They are often not visible, and can cause silent
+problems and misleading unexpected changes. For example, some editors quietly delete them by default.

README.md

@@ -1,92 +1,71 @@
-# getting-started-with-php-symfony
+# Getting started with Guidelines
 
+[![Deploy at Divio
+badge](https://img.shields.io/badge/deploy%20at%20divio-DFFF67)](https://control.divio.com/new?template_url=https://github.com/divio/getting-started-with-php-symfony/archive/refs/heads/main.zip)
 
 
-## Getting started
+This is a template project to bootstrap a PHP Symfony application.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Quick Start with Divio Cloud
 
-## Add your files
+### Create a free Divio account
+Create a free [Divio account](https://control.divio.com/).
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+### Deploy your app in Divio Cloud
+- Click the `Deploy at Divio` button above and provide the information requested by the app creation wizard (eg. app name and app settings)
 
-```
-cd existing_repo
-git remote add origin https://gitlab.com/divio/incubator/getting-started-with-php-symfony.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
+- In Divio Control Panel dashboard, Add `MySQL` database under Services section.
 
-- [ ] [Set up project integrations](https://gitlab.com/divio/incubator/getting-started-with-php-symfony/-/settings/integrations)
+- Under settings, add the `Release Command` for database migration:
+    - `bash /app/migrate.sh`
+(`Release Commands` are the commands executed at the start of app container).
 
-## Collaborate with your team
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+- Deploy an environment; test or live. Open the Env URL in your browser.
 
-## Test and Deploy
+For more details about Divio system, read [Divio documentation](https://docs.divio.com/introduction/)
 
-Use the built-in continuous integration in GitLab.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+## Setup your local development environment with Divio CLI
 
-***
+Please follow our simple guidelines for [Divio CLI installation](https://docs.divio.com/introduction/01-installation/) and [setup local development](https://docs.divio.com/introduction/01-installation/#tutorial-installation&gsc.tab=0)
 
-# Editing this README
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+## Setup your local development environment without Divio CLI
 
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+### Install Docker
 
-## Name
-Choose a self-explaining name for your project.
+This project uses Docker and docker-compose which you can install from the [offical Docker website](https://docs.docker.com/get-docker/).
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+### Clone the repository
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+```
+git clone https://github.com/divio/getting-started-with-php-symfony.git
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+### Build the project
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+Let's build the docker image of the project.
+```
+cd getting-started-with-php-symfony
+docker-compose build
+```
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+### Run the project
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+```
+docker-compose up
+```
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+This command will start the `web` and `db` services. You can reach the web application at [http://localhost:8000]().
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## How to develop
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+Follow the official [Symfony docs](https://symfony.com/doc/current/setup.html#creating-symfony-applications)
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
 
-## License
-For open source projects, say how it is licensed.
+## Contribute to the project
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+See the [contribution guide](./CONTRIBUTING.md).