-
-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
1,241 additions
and
742 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,257 +1,22 @@ | ||
| "use client"; | ||
|
|
||
| import { useSearchParams } from "next/navigation"; | ||
| import classNames from "classnames"; | ||
| import styles from "./Timeline.module.css"; | ||
| import InstallCode from "./timeline/Install.mdx"; | ||
| import ExposeCode from "./timeline/Expose.mdx"; | ||
| import PlugCode from "./timeline/Plug.mdx"; | ||
| import NativeCode from "./timeline/Native.mdx"; | ||
| import CodeBlock from "./timeline/CodeBlock"; | ||
| import StepContent from "./timeline/StepContent"; | ||
| import TimelineStepTitle from "./timeline/TimelineStepTitle"; | ||
| import ListPoint from "./timeline/ListPoint"; | ||
| import Link from "components/common/Link"; | ||
| import TimelineSymfony from "./timeline/TimelineSymfony"; | ||
| import TimelineLaravel from "./timeline/TimelineLaravel"; | ||
|
|
||
| export default function Timeline() { | ||
| const searchParams = useSearchParams(); | ||
| const stack = searchParams.get("s"); | ||
| return ( | ||
| <div | ||
| className={classNames( | ||
| "w-full ml-auto mt-4 relative border-dotted border-l-blue pt-8 | sm:pt-20 sm:border-l-2 sm:text-left md:w-1/2", | ||
| styles.timeline | ||
| )} | ||
| > | ||
| <div className="relative dark:bg-blue-black"> | ||
| <TimelineStepTitle step={1}>Install the framework</TimelineStepTitle> | ||
| <StepContent> | ||
| Install Docker and optionally GitHub CLI. | ||
| <CodeBlock title="Install"> | ||
| <InstallCode /> | ||
| </CodeBlock> | ||
| </StepContent> | ||
| <StepContent className="sm:mt-32"> | ||
| <p className="font-semibold text-blue text-2xl mb-4 leading-tight"> | ||
| Your development environment is ready!{" "} | ||
| </p> | ||
| Continuous integration (GitHub Action) as well as recipes to deploy in | ||
| production with{" "} | ||
| <Link | ||
| href="/docs/deployment/docker-compose/#deploying-with-docker-compose" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| Docker Compose | ||
| </Link>{" "} | ||
| or{" "} | ||
| <Link | ||
| href="/docs/deployment/kubernetes/" | ||
| className="link" | ||
| prefetch={false} | ||
| > | ||
| Kubernetes | ||
| </Link>{" "} | ||
| are also pre-installed. | ||
| </StepContent> | ||
| <TimelineStepTitle step={2}> | ||
| Define the resources | ||
| <span className="block text-xl normal-case"> | ||
| as PHP classes, or using OpenAPI | ||
| </span> | ||
| </TimelineStepTitle> | ||
| <StepContent> | ||
| <CodeBlock title="Define the resources to expose"> | ||
| <ExposeCode /> | ||
| </CodeBlock> | ||
| You get: | ||
| <ul className="mt-8 mb-16"> | ||
| <ListPoint> | ||
| A stable <strong>state-of-the-art</strong>{" "} | ||
| <Link | ||
| href="/docs/distribution/#introduction" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| REST | ||
| </Link>{" "} | ||
| &{" "} | ||
| <Link | ||
| href="/docs/core/graphql/" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| GraphQL | ||
| </Link>{" "} | ||
| API | ||
| </ListPoint> | ||
| <ListPoint> | ||
| <strong>Automatic documentation</strong>{" "} | ||
| <Link | ||
| href="/docs/core/openapi/" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| OpenAPI | ||
| </Link> | ||
| , SwaggerUI, GraphiQL... | ||
| </ListPoint> | ||
| <ListPoint> | ||
| Support for <strong>standards</strong> and formats{" "} | ||
| <Link | ||
| href="/docs/core/extending-jsonld-context/#jsonld" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| JSON-LD | ||
| </Link> | ||
| ,{" "} | ||
| <Link | ||
| href="/docs/core/extending-jsonld-context/#hydra" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| Hydra | ||
| </Link> | ||
| , JSON:API | ||
| </ListPoint> | ||
| </ul> | ||
| <p> | ||
| Alternatively,{" "} | ||
| <Link | ||
| href="/docs/schema-generator" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| generate the classes from an existing RDF vocabulary | ||
| </Link> | ||
| . | ||
| <br /> | ||
| <br /> API Platform automatically exposes production-grade{" "} | ||
| <strong> | ||
| <Link | ||
| className="link" | ||
| href="/docs/distribution/#a-bookshop-api" | ||
| prefetch={false} | ||
| > | ||
| HATEOAS | ||
| </Link> | ||
| </strong>{" "} | ||
| API for you! | ||
| </p> | ||
| </StepContent> | ||
| <TimelineStepTitle step={3}> | ||
| Plug your business & persistence logic | ||
| </TimelineStepTitle> | ||
| <StepContent withPoint={false}> | ||
| <CodeBlock title="Plug your logic"> | ||
| <PlugCode /> | ||
| </CodeBlock> | ||
| <p className="mt-6 sm:mt-0"> | ||
| The framework has been designed from the ground up to be usable from | ||
| Rapid Application Development contexts to{" "} | ||
| <Link className="link" href="/docs/core/design/" prefetch={false}> | ||
| Domain-Driven Design | ||
| </Link>{" "} | ||
| or Clean Architecture-like approaches. | ||
| </p> | ||
| <p className="mb-4 sm:mb-24">You can even mix both approaches!</p> | ||
| </StepContent> | ||
| <StepContent> | ||
| <p className="font-semibold text-blue text-2xl mb-4 leading-tight"> | ||
| ...or use the native integration with popular persistence libraries! | ||
| </p> | ||
| <CodeBlock title="Native integration"> | ||
| <NativeCode /> | ||
| </CodeBlock> | ||
| <br /> | ||
| <p> | ||
| API Platform can automatically{" "} | ||
| <Link | ||
| className="link" | ||
| href="/docs/core/state-providers/#state-providers" | ||
| prefetch={false} | ||
| > | ||
| retrieve | ||
| </Link> | ||
| ,{" "} | ||
| <Link | ||
| className="link" | ||
| href="/docs/core/state-processors/" | ||
| prefetch={false} | ||
| > | ||
| persist | ||
| </Link> | ||
| ,{" "} | ||
| <Link | ||
| href="/docs/core/pagination" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| paginate | ||
| </Link>{" "} | ||
| and{" "} | ||
| <Link | ||
| href="/docs/core/validation" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| validate | ||
| </Link>{" "} | ||
| data using the most popular database systems. | ||
| </p> | ||
| <p> | ||
| <Link | ||
| href="/docs/distribution/#plugging-the-persistence-system" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| PostgreSQL | ||
| </Link> | ||
| ,{" "} | ||
| <Link href="/docs/core/mongodb/" prefetch={false} className="link"> | ||
| MongoDB | ||
| </Link> | ||
| ,{" "} | ||
| <Link | ||
| href="/docs/core/elasticsearch/#elasticsearch-support" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| ElasticSearch | ||
| </Link> | ||
| , SQLite, MySQL, MariaDB, SQL Server and Oracle are supported{" "} | ||
| <Link href="/docs/core/state-providers/#state-providers"> | ||
| out of the box | ||
| </Link> | ||
| . | ||
| </p> | ||
| </StepContent> | ||
| <StepContent className="sm:mt-24"> | ||
| <p className="font-semibold text-blue text-2xl leading-tight"> | ||
| You can also make your own{" "} | ||
| <Link | ||
| href="/docs/core/state-processors/" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| persistence system | ||
| </Link> | ||
| ! | ||
| </p> | ||
| </StepContent> | ||
| <TimelineStepTitle step={4}>Customize!</TimelineStepTitle> | ||
| <StepContent withPoint={false}> | ||
| <p> | ||
| Customize every single behavior thanks to our carefully designed | ||
| <Link | ||
| href="/docs/core/extending/" | ||
| prefetch={false} | ||
| className="link" | ||
| > | ||
| {" "} | ||
| extension points | ||
| </Link> | ||
| . | ||
| </p> | ||
| <br /> | ||
| </StepContent> | ||
| </div> | ||
| {stack === "laravel" ? <TimelineLaravel />: <TimelineSymfony />} | ||
| </div> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.