https://github.com/yuriidorosh/codeigniter4-template

CodeIgniter 4 Template Project Empower your development journey with this feature-rich template boasting Docker, Nginx, MySQL, Redis, Adminer, phplint, Psalm, and PHP_CodeSniffer. Seamlessly build and maintain robust CodeIgniter 4 applications with ease and confidence.
https://github.com/yuriidorosh/codeigniter4-template

adminer codeigniter codeigniter-template codeigniter4 docker docker-compose mysql nginx nginx-docker php php-framework php-linter php-template php8 redis redis-cache

Last synced: about 1 month ago
JSON representation

CodeIgniter 4 Template Project Empower your development journey with this feature-rich template boasting Docker, Nginx, MySQL, Redis, Adminer, phplint, Psalm, and PHP_CodeSniffer. Seamlessly build and maintain robust CodeIgniter 4 applications with ease and confidence.

• Host: GitHub
• URL: https://github.com/yuriidorosh/codeigniter4-template
• Owner: YuriiDorosh
• License: mit
• Created: 2024-03-07T20:05:14.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-09T23:59:59.000Z (8 months ago)
• Last Synced: 2024-10-14T00:04:10.255Z (about 1 month ago)
• Topics: adminer, codeigniter, codeigniter-template, codeigniter4, docker, docker-compose, mysql, nginx, nginx-docker, php, php-framework, php-linter, php-template, php8, redis, redis-cache
• Language: PHP
• Homepage:
• Size: 183 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# CodeIgniter 4 Template Project

This is a template project for CodeIgniter 4, a powerful PHP framework for building web applications. It comes pre-configured with Docker, Nginx, MySQL, Adminer, phplint, Psalm, and PHP_CodeSniffer to streamline your development process.



[![View Counter](https://views.whatilearened.today/views/github/YuriiDorosh/CodeIgniter4-template.svg)](https://views.whatilearened.today/views/github/YuriiDorosh/Information-Theory-and-Coding)

![GitHub repo size](https://img.shields.io/github/repo-size/YuriiDorosh/CodeIgniter4-template)

![GitHub License](https://img.shields.io/github/license/YuriiDorosh/CodeIgniter4-template)

![GitHub issues](https://img.shields.io/github/issues/YuriiDorosh/CodeIgniter4-template)

![GitHub last commit](https://img.shields.io/github/last-commit/YuriiDorosh/CodeIgniter4-template)

![GitHub contributors](https://img.shields.io/github/contributors/YuriiDorosh/CodeIgniter4-template)



## 🚀 Features

- **Dockerized Environment:** Jumpstart development with containers for PHP, Nginx, MySQL, and Redis.

- **Web Server:** Pre-configured Nginx for robust performance.

- **Database Ready:** MySQL setup for data storage and Redis for fast data caching.

- **Development Tools:** Integrated Adminer, phplint, Psalm, and PHP_CodeSniffer to ensure code quality.

- **Custom PHP Configuration:** Tailored php.ini for optimal development and production environments.

## 🔧 Requirements

Before getting started, ensure that you have the following software installed on your system:

- Docker

- Docker Compose

## 🛠 Getting Started

To set up and run the project on your local machine, follow these steps:

### 1. Clone the Repository

```bash

git clone https://github.com/YuriiDorosh/CodeIgniter4-template.git

cd CodeIgniter4-template

```

### 2. Environment Configuration

Copy the example environment file and configure it as needed:

```

cp env .env

```

### 3. Start Docker Containers

Run Docker Compose to start the development environment:

```

docker-compose up -d

```

This command will create and start the Docker containers defined in the docker-compose.yml file.

### 4. Install Composer Dependencies

```

docker-compose exec php composer install

```

### 5. Access the Application

Once the Docker containers are running, you can access the application in your web browser:

- CodeIgniter Application: http://localhost:8080

- Adminer (Database Management Tool): http://localhost:8081

### 6. Development Workflow

Running phplint

```

docker-compose exec php make phplint

```

Running Psalm

```

docker-compose exec php make psalm

```

Running PHP_CodeSniffer

```

docker-compose exec php make phpcs

```

### 7. Stopping the Containers

When you're done working on the project, you can stop the Docker containers:

```

docker-compose down

```

## 📚 Documentation

For detailed documentation about CodeIgniter 4, visit the [official documentation](https://www.codeigniter.com/user_guide/intro/index.html).

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.