Skip to content

Commit

Permalink
Revamp the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dunglas committed Feb 12, 2018
1 parent 547244d commit a7c74f7
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 4,408 deletions.
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ First of all, thank you for contributing, you're awesome!

To have your code integrated in the API Platform project, there is some rules to follow, but don't panic, it's easy!

## Reporting bugs
## Reporting Bugs

If you happen to find a bug, we kindly request you to report it. However, before submitting it, please:

Expand All @@ -18,7 +18,7 @@ Then, if it appears that it's a real bug, you may report it using Github by foll

> _NOTE:_ Don’t hesitate giving as much information as you can (OS, PHP version extensions...)
## Pull requests
## Pull Requests

### Writing a Pull Request

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015 Kévin Dunglas
Copyright (c) 2015-present Kévin Dunglas

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
52 changes: 27 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
<p align="center"><a href="https://api-platform.com"><img src="https://api-platform.com/logo-250x250.png" alt="API Platform"></a></p>

API Platform is a next-generation web framework designed to easily create API-first projects without
compromising extensibility and flexibility:

* Design your own data model as plain old PHP classes or [**import an existing one**](https://api-platform.com/docs/schema-generator/) from the [Schema.org](https://schema.org/) vocabulary
* **Expose in minutes a hypermedia REST API** with pagination, data validation, access control, relation embedding, filters and error handling...
* Benefit from Content Negotiation: [GraphQL](http://graphql.org), [JSON-LD](http://json-ld.org), [Hydra](http://hydra-cg.com), [HAL](http://stateless.co/hal_specification.html), [YAML](http://yaml.org/), [JSON](http://www.json.org/), [XML](https://www.w3.org/XML/) and [CSV](https://www.ietf.org/rfc/rfc4180.txt) are supported out of the box
API Platform is a next-generation web framework designed to easily create API-first projects without compromising extensibility
and flexibility:

* Design your own data model as plain old PHP classes or [**import an existing one**](https://api-platform.com/docs/schema-generator/)
from the [Schema.org](https://schema.org/) vocabulary
* **Expose in minutes a hypermedia REST or a GraphQL API** with pagination, data validation, access control, relation embedding,
filters and error handling...
* Benefit from Content Negotiation: [GraphQL](http://graphql.org), [JSON-LD](http://json-ld.org), [Hydra](http://hydra-cg.com),
[HAL](http://stateless.co/hal_specification.html), [YAML](http://yaml.org/), [JSON](http://www.json.org/), [XML](https://www.w3.org/XML/) and [CSV](https://www.ietf.org/rfc/rfc4180.txt) are supported out of the box
* Enjoy the **beautiful automatically generated API documentation** (Swagger/OpenAPI)
* Add [**a convenient Material Design administration interface**](https://github.com/api-platform/admin) built with [React](https://facebook.github.io/react/) without writing a line of code
* **Scaffold a fully functional Single-Page-Application** built with [React](https://facebook.github.io/react/), [Redux](http://redux.js.org/), [React Router](https://reacttraining.com/react-router/) and [Bootstrap](https://getbootstrap.com/) thanks to [the client generator](https://api-platform.com/docs/client-generator/)
* Install a development environment and deploy your project in production using **[Docker](https://docker.com)**
* Add [**a convenient Material Design administration interface**](https://github.com/api-platform/admin) built with [React](https://facebook.github.io/react/)
without writing a line of code
* **Scaffold a fully functional Single-Page-Application** built with [React](https://facebook.github.io/react/), [Redux](http://redux.js.org/),
[React Router](https://reacttraining.com/react-router/) and [Bootstrap](https://getbootstrap.com/) thanks to [the client
generator](https://api-platform.com/docs/client-generator/) (a Vue.js generator is also available)
* Install a development environment and deploy your project in production using **[Docker](https://docker.com)** and [Kubernetes](http://kubernetes.io/)
* Easily add **[JSON Web Token](https://jwt.io/) or [OAuth](https://oauth.net/) authentication**
* Create specs and tests with a **developer friendly API testing tool** on top
of [Behat](http://behat.org/)
* Create specs and tests with a **developer friendly API testing tool** on top of [Behat](http://behat.org/)

[![Build Status](https://travis-ci.org/api-platform/core.svg?branch=master)](https://travis-ci.org/api-platform/core)
[![Build status](https://ci.appveyor.com/api/projects/status/grwuyprts3wdqx5l?svg=true)](https://ci.appveyor.com/project/dunglas/dunglasapibundle)
Expand All @@ -22,24 +27,21 @@ compromising extensibility and flexibility:

The official project documentation is available **[on the API Platform website](https://api-platform.com)**.

API Platform embraces open web standards (Swagger, JSON-LD, Hydra, HAL, JWT, OAuth,
HTTP...) and the [Linked Data](https://www.w3.org/standards/semanticweb/data) movement. Your API will automatically
expose structured data in Schema.org/JSON-LD. It means that your API Platform application
is usable **out of the box** with technologies of the semantic
web.
API Platform embraces open web standards (Swagger, JSON-LD, GraphQL, Hydra, HAL, JWT, OAuth, HTTP...) and the [Linked Data](https://www.w3.org/standards/semanticweb/data)
movement. Your API will automatically expose structured data in Schema.org/JSON-LD. It means that your API Platform application
is usable **out of the box** with technologies of the semantic web.

It also means that **your SEO will be improved** because **[Google leverages these
formats](https://developers.google.com/structured-data/)**.
It also means that **your SEO will be improved** because **[Google leverages these formats](https://developers.google.com/structured-data/)**.

Last but not least, API Platform is built on top of the [Symfony](https://symfony.com) framework.
Last but not least, the server component of API Platform is built on top of the [Symfony](https://symfony.com) framework,
while client components leverage [React](https://reactjs.org/) (a [Vue.js](https://vuejs.org/) flavor is also available).
It means than you can:

* use **thousands of Symfony bundles** with API Platform
* integrate API Platform in **any existing Symfony application**
* reuse **all your Symfony skills** and benefit of the incredible
amount of Symfony documentation
* enjoy the popular [Doctrine ORM](http://www.doctrine-project.org/projects/orm.html) (used by default, but fully optional: you can
use the data provider you want, including but not limited to MongoDB ODM and ElasticSearch)
* use **thousands of Symfony bundles and React components** with API Platform
* integrate API Platform in **any existing Symfony or React application**
* reuse **all your Symfony and React skills**, benefit of the incredible amount of documentation available
* enjoy the popular [Doctrine ORM](http://www.doctrine-project.org/projects/orm.html) (used by default, but fully optional:
you can use the data provider you want, including but not limited to MongoDB and ElasticSearch)

Install
-------
Expand Down
Loading

0 comments on commit a7c74f7

Please sign in to comment.