Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Features/redis #25

Merged
merged 2 commits into from
Mar 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ The MIT License (MIT)

Copyright (c) 2014-2019 British Columbia Institute of Technology
Copyright (c) 2019-2023 CodeIgniter Foundation
Copyright (c) 2004 Yurii Dorosh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
42 changes: 26 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
<div align="center">

# 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.

<img src="https://socialify.git.ci/YuriiDorosh/CodeIgniter4-template/image?font=Source%20Code%20Pro&forks=1&issues=1&language=1&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Dark" alt="guilyx" width="700" height="300" />

[![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)

<img src="https://socialify.git.ci/YuriiDorosh/CodeIgniter4-template/image?font=Source%20Code%20Pro&forks=1&issues=1&language=1&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Dark" alt="guilyx" width="700" height="300" />

<br>
</div>

## 🚀 Features

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.
- **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.

## Features

- Dockerized development environment
- Nginx web server configuration
- Custom PHP configuration (php.ini)
- MySQL database server
- Redis for data caching
- Adminer database management tool
- Automated code linting and analysis with phplint, Psalm, and PHP_CodeSniffer

## Requirements
## 🔧 Requirements

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

- Docker
- Docker Compose

## Getting Started
## 🛠 Getting Started

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

Expand Down Expand Up @@ -100,3 +99,14 @@ 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.
Loading