Skip to content

Commit

Permalink
Merge branch 'docs-improve-readme' of https://github.com/utopia-php/http
Browse files Browse the repository at this point in the history
 into chore-rename-to-http
  • Loading branch information
TorstenDittmann committed Jan 5, 2024
2 parents 43f8847 + 6b6ae76 commit 4a3ffd2
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 70 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ body:
- type: dropdown
id: utopia-version
attributes:
label: "🎲 Utopia Framework version"
label: "🎲 Utopia Http version"
description: "What version of Utopia are you running?"
options:
- Version 0.18.x
Expand Down
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Contributing

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

## How to Start?

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!

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

## Code of Conduct

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

## Submit a Pull Request 🚀

Expand Down Expand Up @@ -72,38 +72,38 @@ $ git push origin [name_of_your_new_branch]

## Introducing New Features

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

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

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

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

## Other Ways to Help

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

### Blogging & Speaking

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

### Presenting at Meetups

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

### Sending Feedbacks & Reporting Bugs

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

### Submitting New Ideas

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

### Improving Documentation

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

### Helping Someone

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!
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!
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg)
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA)

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

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

## Getting Started

Install using composer:
Install using Composer:

```bash
composer require utopia-php/http
```
Expand Down Expand Up @@ -49,7 +50,7 @@ $http->start();
Run HTTP server:

```bash
php -S localhost:8000 src/server2.php
php -S localhost:8000 src/server.php
```

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

### Server Adapters

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.
The library supports server adapters to be able to run on any PHP setup. Youx1s could use the FPM server or the Swoole server.

#### Use PHP FPM server

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

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.

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

## System Requirements

Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.

## More from Utopia

Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia framework.
Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia Http.

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.

Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
{
"name": "utopia-php/http",
"description": "A simple, light and advanced PHP framework",
"description": "A simple, light and advanced PHP HTTP framework",
"type": "library",
"keywords": [
"php",
"framework",
"http",
"upf"
],
"license": "MIT",
Expand Down
8 changes: 4 additions & 4 deletions docs/Getting-Starting-Guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Getting Started with Utopia-PHP

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

# Defining Routes
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.
Expand Down Expand Up @@ -279,9 +279,9 @@ Http::shutdown(function($request) {


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

> Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible.
> Utopia Http requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
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).
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).

11 changes: 0 additions & 11 deletions tests/Validator/DomainTest.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
<?php
/**
* Utopia PHP Framework
*
* @package Framework
* @subpackage Tests
*
* @link https://github.com/utopia-php/http
* @author Appwrite Team <team@appwrite.io>
* @version 1.0 RC4
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
*/

namespace Utopia\Http\Validator;

Expand Down
11 changes: 0 additions & 11 deletions tests/Validator/HostTest.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
<?php
/**
* Utopia PHP Framework
*
* @package Framework
* @subpackage Tests
*
* @link https://github.com/utopia-php/http
* @author Appwrite Team <team@appwrite.io>
* @version 1.0 RC4
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
*/

namespace Utopia\Http\Validator;

Expand Down
11 changes: 0 additions & 11 deletions tests/Validator/IPTest.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
<?php
/**
* Utopia PHP Framework
*
* @package Framework
* @subpackage Tests
*
* @link https://github.com/utopia-php/http
* @author Appwrite Team <team@appwrite.io>
* @version 1.0 RC4
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
*/

namespace Utopia\Http\Validator;

Expand Down
11 changes: 0 additions & 11 deletions tests/Validator/URLTest.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
<?php
/**
* Utopia PHP Framework
*
* @package Framework
* @subpackage Tests
*
* @link https://github.com/utopia-php/http
* @author Appwrite Team <team@appwrite.io>
* @version 1.0 RC4
* @license The MIT License (MIT) <http://www.opensource.org/licenses/mit-license.php>
*/

namespace Utopia\Http\Validator;

Expand Down

0 comments on commit 4a3ffd2

Please sign in to comment.