Skip to content

Commit 4a3ffd2

Browse files
Merge branch 'docs-improve-readme' of https://github.com/utopia-php/http into chore-rename-to-http
2 parents 43f8847 + 6b6ae76 commit 4a3ffd2

9 files changed

Lines changed: 28 additions & 70 deletions

File tree

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ body:
3434
- type: dropdown
3535
id: utopia-version
3636
attributes:
37-
label: "🎲 Utopia Framework version"
37+
label: "🎲 Utopia Http version"
3838
description: "What version of Utopia are you running?"
3939
options:
4040
- Version 0.18.x

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Contributing
22

3-
We would ❤️ for you to contribute to Framework and help make it better! We want contributing to Framework to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
3+
We would ❤️ for you to contribute to Utopia-PHP Http and help make it better! We want contributing to Http to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
44

55
## How to Start?
66

77
If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or [@appwrite_io](https://twitter.com/appwrite_io) on Twitter, and anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you!
88

9-
You can get an in-depth understanding of the Utopia-PHP framework in our [Getting Started](docs/Getting-Starting-Guide.md) guide.
9+
You can get an in-depth understanding of the Utopia-PHP Http in our [Getting Started](docs/Getting-Starting-Guide.md) guide.
1010

1111
## Code of Conduct
1212

13-
Help us keep framework open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
13+
Help us keep Utopia-PHP Http open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
1414

1515
## Submit a Pull Request 🚀
1616

@@ -72,38 +72,38 @@ $ git push origin [name_of_your_new_branch]
7272

7373
## Introducing New Features
7474

75-
We would 💖 you to contribute to Framework, but we would also like to make sure Framework is as great as possible and loyal to its vision and mission statement 🙏.
75+
We would 💖 you to contribute to Utopia-PHP HTTP, but we would also like to make sure Http is as great as possible and loyal to its vision and mission statement 🙏.
7676

7777
For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.
7878

79-
This will allow the Framework community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
79+
This will allow the Utopia-PHP Http community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
8080

81-
This is also important for the Framework lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc).
81+
This is also important for the Http lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc).
8282

8383
## Other Ways to Help
8484

85-
Pull requests are great, but there are many other areas where you can help Framework
85+
Pull requests are great, but there are many other areas where you can help Utopia-PHP Http
8686

8787
### Blogging & Speaking
8888

89-
Blogging, speaking about, or creating tutorials about one of Framework's many features is great way to contribute and help our project grow.
89+
Blogging, speaking about, or creating tutorials about one of Http's many features is great way to contribute and help our project grow.
9090

9191
### Presenting at Meetups
9292

93-
Presenting at meetups and conferences about your Framework projects. Your unique challenges and successes in building things with Framework can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!
93+
Presenting at meetups and conferences about your Http projects. Your unique challenges and successes in building things with Utopia-PHP Http can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!
9494

9595
### Sending Feedbacks & Reporting Bugs
9696

97-
Sending feedback is a great way for us to understand your different use cases of Framework better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).
97+
Sending feedback is a great way for us to understand your different use cases of Utopia-PHP Http better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).
9898

9999
### Submitting New Ideas
100100

101-
If you think Framework could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
101+
If you think Utopia-PHP Http could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
102102

103103
### Improving Documentation
104104

105105
Submitting documentation updates, enhancements, designs, or bug fixes. Spelling or grammar fixes will be very much appreciated.
106106

107107
### Helping Someone
108108

109-
Searching for Framework on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Framework's repo!
109+
Searching for Utopia-PHP Http on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Http's repo!

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg)
77
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA)
88

9-
Utopia Framework is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io).
9+
Utopia Http is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io).
1010

11-
Utopia Framework is dependency-free. Any extra features, such as authentication or caching, will be available as standalone models in order to keep the framework core clean, light, and easy to learn.
11+
Utopia Http is dependency-free. Any extra features, such as authentication or caching are available as standalone models in order to keep the framework core clean, light, and easy to learn.
1212

1313
## Getting Started
1414

15-
Install using composer:
15+
Install using Composer:
16+
1617
```bash
1718
composer require utopia-php/http
1819
```
@@ -49,7 +50,7 @@ $http->start();
4950
Run HTTP server:
5051

5152
```bash
52-
php -S localhost:8000 src/server2.php
53+
php -S localhost:8000 src/server.php
5354
```
5455

5556
Send HTTP request:
@@ -60,7 +61,7 @@ curl http://localhost:8000/hello-world
6061

6162
### Server Adapters
6263

63-
The library supports server adapters to be able to run on any PHP setup. For instance, you could use the FPM server or the Swoole server.
64+
The library supports server adapters to be able to run on any PHP setup. Youx1s could use the FPM server or the Swoole server.
6465

6566
#### Use PHP FPM server
6667

@@ -243,15 +244,15 @@ In advanced scenarios, resources can also be injected into other resources or en
243244

244245
Resources are designed to prepare dependencies or context for the request. Resources are not meant to do functional logic or return callbacks. For such a use case, you should use hooks.
245246

246-
To learn more about Framework architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md).
247+
To learn more about Http architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md).
247248

248249
## System Requirements
249250

250-
Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
251+
Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
251252

252253
## More from Utopia
253254

254-
Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia framework.
255+
Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia Http.
255256

256257
Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project.
257258

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"name": "utopia-php/http",
3-
"description": "A simple, light and advanced PHP framework",
3+
"description": "A simple, light and advanced PHP HTTP framework",
44
"type": "library",
55
"keywords": [
66
"php",
77
"framework",
8+
"http",
89
"upf"
910
],
1011
"license": "MIT",

docs/Getting-Starting-Guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Getting Started with Utopia-PHP
22

33
# Intro
4-
Utopia Framework is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more.
4+
Utopia Http is an easy-to-use PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. It follows an architecture like Express and is based on the declarative programming approach. Documenting and writing code are usually seen as two separate tasks and very often, documentation loses priority in the software development lifecycle. Utopia unifies the two with a flexible API that allows your code to be self-documenting. What’s interesting about Utopia is its ability to accept metadata along with it’s route definitions. This metadata can then be used for various purposes like generating documentation, swagger specifications and more.
55

66
# Defining Routes
77
If you’re new to Utopia, let’s get started by looking at an example of a basic GET route for an application that you can create using Utopia. We'll be using a [Swoole server](https://github.com/swoole/swoole-src) in this example, but you should be able to extend it to any HTTP server.
@@ -279,9 +279,9 @@ Http::shutdown(function($request) {
279279

280280

281281
# Running Locally
282-
If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the utopia-php/http dependency using `composer require utopia-php/http` command.
282+
If you have PHP and Composer installed on your device, you can run Utopia apps locally by downloading the Utopia-PHP/http dependency using `composer require utopia-php/http` command.
283283

284-
> Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible.
284+
> Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
285285
286-
Wonderful! 😄 You’re all set to create a basic demo app using the Utopia framework. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord).
286+
Wonderful! 😄 You’re all set to create a basic demo app using the Utopia Http. If you have any issues or questions feel free to reach out to us on our [Discord Server](https://appwrite.io/discord).
287287

tests/Validator/DomainTest.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* Utopia PHP Framework
4-
*
5-
* @package Framework
6-
* @subpackage Tests
7-
*
8-
* @link https://github.com/utopia-php/http
9-
* @author Appwrite Team <team@appwrite.io>
10-
* @version 1.0 RC4
11-
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
12-
*/
132

143
namespace Utopia\Http\Validator;
154

tests/Validator/HostTest.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* Utopia PHP Framework
4-
*
5-
* @package Framework
6-
* @subpackage Tests
7-
*
8-
* @link https://github.com/utopia-php/http
9-
* @author Appwrite Team <team@appwrite.io>
10-
* @version 1.0 RC4
11-
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
12-
*/
132

143
namespace Utopia\Http\Validator;
154

tests/Validator/IPTest.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* Utopia PHP Framework
4-
*
5-
* @package Framework
6-
* @subpackage Tests
7-
*
8-
* @link https://github.com/utopia-php/http
9-
* @author Appwrite Team <team@appwrite.io>
10-
* @version 1.0 RC4
11-
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
12-
*/
132

143
namespace Utopia\Http\Validator;
154

tests/Validator/URLTest.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* Utopia PHP Framework
4-
*
5-
* @package Framework
6-
* @subpackage Tests
7-
*
8-
* @link https://github.com/utopia-php/http
9-
* @author Appwrite Team <team@appwrite.io>
10-
* @version 1.0 RC4
11-
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
12-
*/
132

143
namespace Utopia\Http\Validator;
154

0 commit comments

Comments
 (0)