Skip to content

Commit 95a9e3f

Browse files
committed
:pnecil: modify README.md
Signed-off-by: otengkwame <[email protected]>
1 parent 50ce7bd commit 95a9e3f

File tree

1 file changed

+134
-3
lines changed

1 file changed

+134
-3
lines changed

README.md

Lines changed: 134 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Sylynder Engine
22

3-
The engine folder for webby core functionalities
4-
5-
For Develop Branch
3+
The engine folder for Webby Framework Core extended functionalites enabled for CodeIgniter3 framework
64

75
## Folder Structure
86

@@ -23,3 +21,136 @@ vendor/
2321
└── MX/
2422
2523
```
24+
25+
26+
<p align="center">
27+
<img src="webby-readme.png" width="600" alt="Webby">
28+
</p>
29+
30+
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) ![Lines of code](https://img.shields.io/tokei/lines/github/sylynder/engine) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/sylynder/webby) ![Packagist Version](https://img.shields.io/packagist/v/sylynder/engine) ![Packagist Downloads (custom server)](https://img.shields.io/packagist/dt/sylynder/engine)
31+
32+
## About Webby
33+
34+
**Webby** aims to be a "lego-like" PHP framework that allows you to build APIs, Console/Cli and Web Applications in a modular architecture, that can also integrate other features from existing PHP frameworks or other PHP packages with ease.
35+
36+
Build Awesome PHP applications with a "Sweet Application Architecture". It is an extension of the CodeIgniter3 framework for easy web application development with an easy developer experience (DX) for beginners.
37+
38+
## Features
39+
40+
- Easy and Improved Routing
41+
- HMVC First Architecture
42+
- Application can be APIs, Console or Web Based
43+
- Easy to integrate with Other Frameworks
44+
- Extend with Packages
45+
- Use "Plates" a blade-like templating engine for your views
46+
- Use "Services" to seperate business logic from Controllers
47+
- Use "Actions" instead of "Services" for CRUD functionalities or business logic
48+
- Use "Forms Or Rules" to validate input requests
49+
- A near "Service discovery" feature included
50+
51+
## Authors
52+
53+
- [@otengkwame](https://www.github.com/otengkwame)
54+
- [All contributors][link-contributors]
55+
56+
## Installation
57+
58+
The recommended way to install Webby is [through Composer](https://getcomposer.org/).
59+
Are you [New to Composer?](https://getcomposer.org/doc/00-intro.md) click on the link.
60+
61+
This will install the latest PHP supported version:
62+
63+
```bash
64+
$ composer create-project sylynder/webby <project-name>
65+
```
66+
67+
Make sure to replace *project-name* with the name of your project
68+
69+
## Documentation
70+
71+
The main documentation of Webby can be found here: [Webby Docs](https://webby.sylynder.com/docs)
72+
73+
The documentation is currently been updated constantly. It will take time to cover all aspects of the framework but we are working around the clock to make this possible.
74+
75+
Currently we have planned to use the blogs section to guide developers through their journey in learning the framework.
76+
77+
If you have been developing with CodeIgniter3 already and you are familiar with the HMVC approach you can still use the same knowlegde to get going.
78+
79+
For developers who are very familiar with the CodeIgniter3 framework can still refer to the documentation here: [CI3 Docs](https://www.codeigniter.com/userguide3/index.html)
80+
81+
82+
## Server Requirements
83+
84+
PHP version 8.0 or newer is recommended.
85+
86+
PHP 8.1 was released in November 2021 and so most of it's functionalities were not known to be supported yet, this delayed the development of this project to work perfectly with the latest version 8.1 of PHP and the framework, ~~we advise to stay between versions 7.4 and 8.0 for stable PHP appplication development.~~
87+
88+
~~If you want to discover bugs and contribute, then you are welcome to use the PHP 8.1 version.~~
89+
90+
Currently it supports 8.1 but no issues have come up yet. We will be looking forward to that as 8.2 is to be released later.
91+
92+
93+
## Quick FAQs
94+
95+
#### Why did you decide to create Webby
96+
---
97+
* Webby was created with PHP beginners in mind, to simplify how web applications can be built without complex concepts and functionalities
98+
* Looking at how other frameworks makes it difficult for beginners to start, we are making the approach different.
99+
* Also CodeIgniter was not been updated for sometime and new PHP versions were not working until they updated to the recent version (3.1.13).
100+
101+
#### Is it anything different from CodeIgniter 3 or 4?
102+
---
103+
It uses the Core of the CodeIgniter3 framework and borrows some new features added from CodeIgniter 4. It is designed to move developers who are familiar with CI3 to easily move to CI4 with a little similar syntax or concept.
104+
105+
## Important Links
106+
107+
The links below will guide you to know more about how Webby Works
108+
109+
* [Installation Guide](https://webby.sylynder.com/docs/installation/)
110+
* [Getting Started](https://webby.sylynder.com/docs/getting-started/)
111+
* [Contribution Guide](https://webby.sylynder.com/docs/contribution-guide/)
112+
* [Learn Webby](https://webby.sylynder.com/blogs/)
113+
* [Community](https://github.com/sylynder/webby/discussions)
114+
115+
## What's Next
116+
There are lots of future plans for Webby
117+
118+
* [x] Enable and Test for PHP 8.1 compatibility
119+
* [x] Improve and simplify CI3's database migrations
120+
* [x] Enable module based packages to use composer packages
121+
* [x] Enable easy engine folder upgrade (Currently folder will have to be replaced when an update is available) (Done on 30th October 2022 18:22 PM)
122+
* [ ] Create a compatible HTTP and Routing feature (may be PSR-7 compatible) that enables general integration with other frameworks
123+
* [ ] Improve and optimize speed
124+
* [ ] Improve on cli or console feature
125+
* [ ] Integrate asynchronous features (may be fibers) [as a package]
126+
* [ ] And many more to add (and many more to learn)
127+
* [ ] Write version two (v2) without a major class api change so as to reduce future upgrade headache. Unlike other major PHP Frameworks
128+
129+
130+
131+
## Used By
132+
133+
This project is used by the following companies:
134+
135+
- Seguah Dreams
136+
- Glomot Company
137+
- Wigal Vision
138+
139+
## Credits
140+
141+
- Rougin (https://github.com/rougin/spark-plug)
142+
- Yidas (https://github.com/yidas/codeigniter-rest)
143+
- Chriskacerguis (https://github.com/chriskacerguis/codeigniter-restserver)
144+
- Nobitadore (https://github.com/nobitadore/Arrayz)
145+
- Lonnieezell (https://github.com/lonnieezell/Bonfire)
146+
- GustMartins (https://github.com/GustMartins/Slice-Library)
147+
- CodeIgniter 3 (https://github.com/bcit-ci/CodeIgniter)
148+
- CodeIgniter 4 (https://github.com/codeigniter4/CodeIgniter4)
149+
- [All contributors][link-contributors]
150+
151+
152+
## License
153+
154+
We are using the MIT License (MIT). Please see our LICENSE.md file. If you want to know more about the license go to [LICENSE]((https://choosealicense.com/licenses/mit/)) for more information.
155+
156+
[link-contributors]: https://github.com/sylynder/engine/contributors

0 commit comments

Comments
 (0)