Merge pull request #64 from RonasIT/extends-init-command

Extends init command

.templates/CONTACTS.md

@@ -0,0 +1,7 @@
+### Contacts
+
+Should you need assistance or have questions, feel free to connect with the following individuals:
+- Manager: If you have any high-level project concerns, feel free to get in touch with our project manager. [Connect with Manager](:manager_link)
+- Code Owner/Team Lead: For specific questions about the codebase or technical aspects, reach out to our team lead. [Connect with Team Lead](:team_lead_link)
+
+Please be mindful of each individual's preferred contact method and office hours.

.templates/CREDENTIALS_AND_ACCESS.md

@@ -0,0 +1,3 @@
+## Credentials and Access
+
+{admin_credentials}Default admin email and password: `:admin_email`/`:admin_password`{/admin_credentials}

.templates/ENVIRONMENTS.md

@@ -0,0 +1,10 @@
+## Environments
+
+This repository by default supports three environments: `local`, `development`,
+and `testing`. Each environment is represented by an appropriate environment file:
+
+| Environment | File | URL                                  |
+| --- | --- |--------------------------------------|
+| local | .env | [http://localhost](http://localhost) |
+| testing | .env.testing | -                                    |
+| development | .env.development | [:api_link](:api_link)               |

.templates/GETTING_STARTED.md

@@ -0,0 +1,15 @@
+## Getting Started
+
+To get started with this repository, follow these steps:
+
+Clone this repository to your local machine.
+
+```sh
+git clone :git_project_path
+```
+
+Build and start containers. It may takes some time.
+
+```sh
+docker compose up -d
+```

.templates/PREREQUISITES.md

@@ -0,0 +1,6 @@
+## Prerequisites
+
+To work with this repository, you will need to have the following
+installed:
+
+- [Docker](https://www.docker.com)

.templates/README.md

@@ -0,0 +1,3 @@
+# :project_name
+
+Project description will be here

.templates/RESOURCES.md

@@ -0,0 +1,10 @@
+### Resources
+
+Below are links to tools and services used in this project:
+{issue_tracker}- Issue Tracker: Here, you can report any issues or bugs related to the project. [Issue Tracker](:issue_tracker_link){/issue_tracker}
+{figma}- Figma: This is where we maintain all our design assets and mock-ups. [Figma](:figma_link){/figma}
+{sentry}- Sentry: To monitor application performance and error tracking. [Sentry](:sentry_link){/sentry}
+{datadog}- DataDog: This is where we monitor our logs, and server performance, and receive alerts. [DataDog](:datadog_link){/datadog}
+{argocd}- ArgoCD: Is a kubernetes controller which continuously monitors running applications. [ArgoCD](:argocd_link){/argocd}
+{telescope}- Laravel Telescope: This is debug assistant for the Laravel framework. [Laravel Telescope](:telescope_link){/telescope}
+- [API Documentation](:api_link)

.templates/RESOURCES_AND_CONTACTS.md

@@ -0,0 +1,5 @@
+## Project Resources & Contacts
+
+This section provides quick links to various resources and contacts associated
+with this project. It's here to streamline your navigation and communication
+process, so you can efficiently find what you need or reach out to who you need.

README.md

@@ -16,26 +16,37 @@ installed:
 To get started with this repository, follow these steps:
 
 Clone this repository to your local machine.
+
 ```sh
 git clone [email protected]:RonasIT/laravel-empty-project.git
 ```
+
 Remove the existing GitHub [remote](https://git-scm.com/docs/git-remote).
+
 ```sh
 git remote remove origin
 ```
+
 Add your project remote.
+
 ```sh
 git remote add origin <project_git_url>
 ```
+
 Build and start containers. It may takes some time.
+
 ```sh
 docker compose up -d
 ```
+
 Check docker containers health status.
+
 ```sh
 docker ps
 ```
+
 You should see something like this.
+
 ```
 CONTAINER ID   IMAGE                       COMMAND                  CREATED              STATUS              PORTS                                                NAMES
 5ae2e24d63bb   ronasit/php-nginx-dev:8.1   "/entrypoint bash -c…"   About a minute ago   Up About a minute   0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 9000/tcp   laravel-empty-project-nginx-1
@@ -44,17 +55,23 @@ e02e9f746731   ronasit/postgres:12.5       "docker-entrypoint.s…"   About a mi
 4e1fda859342   ronasit/postgres:12.5       "docker-entrypoint.s…"   About a minute ago   Up About a minute   0.0.0.0:5432->5432/tcp                               laravel-empty-project-pgsql-1
 728c83486f92   redis:6.2.3                 "docker-entrypoint.s…"   About a minute ago   Up About a minute   0.0.0.0:6379->6379/tcp                               laravel-empty-project-redis-1
 ```
+
 Connect to the `nginx` container.
+
 ```sh
 docker exec -i -t laravel-empty-project-nginx-1 /bin/bash
 ```
+
 Init your new project.
+
 ```sh
 php artisan init <project_name>
 ```
+
 Set required configs: `contact.email` in the `configs/auto-doc.php`.
 
 Run tests to generate documentation
+
 ```sh
 php vendor/bin/phpunit tests/
 ```