diff --git a/README.md b/README.md index beefbdf7..fb823419 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ Integration examples: + [Rocket Example](https://github.com/SeaQL/sea-orm/tree/master/examples/rocket_example) + [Salvo Example](https://github.com/SeaQL/sea-orm/tree/master/examples/salvo_example) + [Tonic Example](https://github.com/SeaQL/sea-orm/tree/master/examples/tonic_example) ++ [Seaography Example](https://github.com/SeaQL/sea-orm/tree/master/examples/seaography_example) ## Features @@ -187,11 +188,21 @@ fruit::Entity::delete_many() ``` +## Seaography: first-class GraphQL integration (preview) + +[Seaography](https://github.com/SeaQL/seaography) is a GraphQL framework built on top of SeaORM. It embodies our vision of 'full-stack Rust': with just a few commands, you can launch a GraphQL server on SeaORM entities! + +Starting `0.12`, `seaography` is integrated into `sea-orm`. While Seaography development is still in an early stage, it especially useful in prototyping and building internal-use admin panels. + + + +Look at the [Seaography Example](https://github.com/SeaQL/sea-orm/tree/master/examples/seaography_example) to learn more. + ## Learn More 1. [Design](https://github.com/SeaQL/sea-orm/tree/master/DESIGN.md) 1. [Architecture](https://www.sea-ql.org/SeaORM/docs/internal-design/architecture/) -1. [Release Model](https://www.sea-ql.org/SeaORM/blog/2021-08-30-release-model) +1. [Engineering](https://www.sea-ql.org/blog/2022-07-30-engineering/) 1. [Change Log](https://github.com/SeaQL/sea-orm/tree/master/CHANGELOG.md) ## Who's using SeaORM? @@ -208,9 +219,6 @@ The following products are powered by SeaORM: -SeaORM is the foundation of: -+ [Seaography](https://github.com/SeaQL/seaography): GraphQL framework for SeaORM - For more projects, see [Built with SeaORM](https://github.com/SeaQL/sea-orm/blob/master/COMMUNITY.md#built-with-seaorm). ## License @@ -232,10 +240,16 @@ dual licensed as above, without any additional terms or conditions. SeaORM is a community driven project. We welcome you to participate, contribute and together help build Rust's future. -A big shout out to our contributors: +A big shout out to our contributors! [![Contributors](https://opencollective.com/sea-orm/contributors.svg?width=1000&button=false)](https://github.com/SeaQL/sea-orm/graphs/contributors) +## Sponsorship + +[SeaQL.org](https://www.sea-ql.org/) is an independent open-source organization run by passionate developers. If you enjoy using our libraries, please star and share our repositories. If you feel generous, a small donation via [GitHub Sponsor](https://github.com/sponsors/SeaQL) will be greatly appreciated, and goes a long way towards sustaining the organization. + +We invite you to participate, contribute and together help build Rust's future. + ## Mascot A friend of Ferris, Terres the hermit crab is the official mascot of SeaORM. His hobby is collecting shells. diff --git a/examples/seaography_example/README.md b/examples/seaography_example/README.md index b4325b47..ac9602d3 100644 --- a/examples/seaography_example/README.md +++ b/examples/seaography_example/README.md @@ -8,23 +8,23 @@ export DATABASE_URL=mysql://sea:sea@localhost/bakery ``` -## Setup the Database first +## Setup the Database -Cd into `migration` folder, follow instructions there, but basically: +Cd into `migration` folder and follow instructions there, but basically: -``` +```sh cargo run ``` ## Install Seaography -``` +```sh cargo install seaography-cli@^1.0.0-rc.2 ``` -## Generate Seaography project +## Generate GraphQL project -``` +```sh rm -rf graphql # this entire folder is generated sea-orm-cli generate entity --output-dir graphql/src/entities --seaography seaography-cli graphql graphql/src/entities $DATABASE_URL sea-orm-seaography-example @@ -32,7 +32,7 @@ seaography-cli graphql graphql/src/entities $DATABASE_URL sea-orm-seaography-exa ## Running the project -``` +```sh cd graphql cargo run ``` diff --git a/src/lib.rs b/src/lib.rs index ce02a92d..826c9253 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -51,6 +51,7 @@ //! + [Rocket Example](https://github.com/SeaQL/sea-orm/tree/master/examples/rocket_example) //! + [Salvo Example](https://github.com/SeaQL/sea-orm/tree/master/examples/salvo_example) //! + [Tonic Example](https://github.com/SeaQL/sea-orm/tree/master/examples/tonic_example) +//! + [Seaography Example](https://github.com/SeaQL/sea-orm/tree/master/examples/seaography_example) //! //! ## Features //! @@ -260,11 +261,21 @@ //! # } //! ``` //! +//! ## Seaography: first-class GraphQL integration (preview) +//! +//! [Seaography](https://github.com/SeaQL/seaography) is a GraphQL framework built on top of SeaORM. It embodies our vision of 'full-stack Rust': with just a few commands, you can launch a GraphQL server on SeaORM entities! +//! +//! Starting `0.12`, `seaography` is integrated into `sea-orm`. While Seaography development is still in an early stage, it especially useful in prototyping and building internal-use admin panels. +//! +//! +//! +//! Look at the [Seaography Example](https://github.com/SeaQL/sea-orm/tree/master/examples/seaography_example) to learn more. +//! //! ## Learn More //! //! 1. [Design](https://github.com/SeaQL/sea-orm/tree/master/DESIGN.md) //! 1. [Architecture](https://www.sea-ql.org/SeaORM/docs/internal-design/architecture/) -//! 1. [Release Model](https://www.sea-ql.org/SeaORM/blog/2021-08-30-release-model) +//! 1. [Engineering](https://www.sea-ql.org/blog/2022-07-30-engineering/) //! 1. [Change Log](https://github.com/SeaQL/sea-orm/tree/master/CHANGELOG.md) //! //! ## Who's using SeaORM? @@ -281,9 +292,6 @@ //! //! //! -//! SeaORM is the foundation of: -//! + [Seaography](https://github.com/SeaQL/seaography): GraphQL framework for SeaORM -//! //! For more projects, see [Built with SeaORM](https://github.com/SeaQL/sea-orm/blob/master/COMMUNITY.md#built-with-seaorm). //! //! ## License @@ -305,10 +313,16 @@ //! //! SeaORM is a community driven project. We welcome you to participate, contribute and together help build Rust's future. //! -//! A big shout out to our contributors: +//! A big shout out to our contributors! //! //! [![Contributors](https://opencollective.com/sea-orm/contributors.svg?width=1000&button=false)](https://github.com/SeaQL/sea-orm/graphs/contributors) //! +//! ## Sponsorship +//! +//! [SeaQL.org](https://www.sea-ql.org/) is an independent open-source organization run by passionate developers. If you enjoy using our libraries, please star and share our repositories. If you feel generous, a small donation via [GitHub Sponsor](https://github.com/sponsors/SeaQL) will be greatly appreciated, and goes a long way towards sustaining the organization. +//! +//! We invite you to participate, contribute and together help build Rust's future. +//! //! ## Mascot //! //! A friend of Ferris, Terres the hermit crab is the official mascot of SeaORM. His hobby is collecting shells.