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.

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.

🚀 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

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.

📄 License

This project is licensed under the MIT License - see the 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.