-
-
Notifications
You must be signed in to change notification settings - Fork 47
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
38 changed files
with
12,487 additions
and
0 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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# SeaORM Documentation | ||
|
||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. | ||
|
||
## Installation | ||
|
||
```console | ||
yarn install | ||
``` | ||
|
||
## Local Development | ||
|
||
```console | ||
yarn start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
## Build | ||
|
||
```console | ||
yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
## Deployment | ||
|
||
```console | ||
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
# Index |
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 |
---|---|---|
@@ -0,0 +1,168 @@ | ||
/** @type {import('@docusaurus/types').DocusaurusConfig} */ | ||
module.exports = { | ||
title: 'SeaORM Pro 🐚 An admin dashboard built on top of SeaORM & Seaography', | ||
tagline: '🐚 SeaORM Pro is an admin dashboard built on top of SeaORM & Seaography', | ||
url: 'https://www.sea-ql.org', | ||
baseUrl: '/SeaORM-Pro/', | ||
onBrokenLinks: 'throw', | ||
onBrokenMarkdownLinks: 'throw', | ||
favicon: 'img/favicon.ico', | ||
organizationName: 'SeaQL', | ||
projectName: 'sea-orm-x', | ||
trailingSlash: true, | ||
themeConfig: { | ||
colorMode: { | ||
respectPrefersColorScheme: true, | ||
}, | ||
image: 'img/SeaORM Pro banner.png', | ||
metadata: [ | ||
{name: 'keywords', content: 'rust, orm, SeaORM Pro, database, sql, mysql, sqlite, postgresql, rocket, tokio, sqlx, actix, async-std'}, | ||
], | ||
navbar: { | ||
title: 'SeaORM Pro', | ||
logo: { | ||
alt: 'SeaORM Pro Logo', | ||
src: 'img/SeaQL.png', | ||
}, | ||
items: [ | ||
{ | ||
type: 'doc', | ||
docId: 'index', | ||
position: 'left', | ||
label: 'Docs', | ||
}, | ||
{ | ||
to: 'https://www.sea-ql.org/blog/', | ||
target: '_self', | ||
label: 'Blog', | ||
position: 'left' | ||
}, | ||
{ | ||
to: 'https://crates.io/crates/sea-orm', | ||
label: 'Crate', | ||
position: 'right', | ||
}, | ||
{ | ||
to: 'https://github.com/SeaQL/sea-orm', | ||
label: 'GitHub', | ||
position: 'right', | ||
}, | ||
], | ||
}, | ||
footer: { | ||
style: 'dark', | ||
links: [ | ||
{ | ||
title: 'Docs', | ||
items: [ | ||
{ | ||
label: 'Getting Started', | ||
to: '/docs/index', | ||
}, | ||
{ | ||
label: 'SeaORM Tutorial', | ||
to: 'https://www.sea-ql.org/sea-orm-tutorial/', | ||
}, | ||
{ | ||
label: 'SeaORM Cookbook', | ||
to: 'https://www.sea-ql.org/sea-orm-cookbook/', | ||
}, | ||
{ | ||
label: 'API Reference', | ||
to: 'https://docs.rs/sea-orm/latest/sea_orm/', | ||
}, | ||
], | ||
}, | ||
{ | ||
title: 'Community', | ||
items: [ | ||
{ | ||
label: 'GitHub', | ||
to: 'https://github.com/SeaQL/sea-orm/discussions', | ||
}, | ||
{ | ||
label: 'Discord', | ||
to: 'https://discord.com/invite/uCPdDXzbdv', | ||
}, | ||
{ | ||
label: 'Twitter', | ||
to: 'https://twitter.com/sea_ql', | ||
}, | ||
{ | ||
label: 'GSoC', | ||
to: 'https://summerofcode.withgoogle.com/programs/2022/organizations/seaql', | ||
}, | ||
], | ||
}, | ||
{ | ||
title: 'More', | ||
items: [ | ||
{ | ||
label: 'Blog', | ||
target: '_self', | ||
to: 'https://www.sea-ql.org/blog/', | ||
}, | ||
{ | ||
label: 'About Us', | ||
to: '/about-us', | ||
}, | ||
{ | ||
label: 'Seaography', | ||
to: 'https://www.sea-ql.org/Seaography/', | ||
}, | ||
], | ||
}, | ||
], | ||
copyright: [ | ||
`<br/><a href="https://github.com/SeaQL/sea-orm/stargazers/" target="_blank"><img src="https://img.shields.io/github/stars/SeaQL/sea-orm.svg?style=social&label=Star"/></a>`, | ||
'<br/>Every ⭐ counts!', | ||
`<br/>Copyright © ${new Date().getFullYear()} SeaQL.org`, | ||
].join(''), | ||
}, | ||
prism: { | ||
// Themes: https://github.com/FormidableLabs/prism-react-renderer/tree/master/packages/prism-react-renderer/src/themes | ||
theme: require('prism-react-renderer/themes/vsLight'), | ||
darkTheme: require('prism-react-renderer/themes/vsDark'), | ||
additionalLanguages: [ | ||
'toml', | ||
'rust', | ||
'bash', | ||
], | ||
}, | ||
// algolia: { | ||
// appId: 'F60BRNGE7P', | ||
// apiKey: 'cb0fff4f36dcd0f3d6a97e12e494dec7', | ||
// indexName: 'seaorm', | ||
// contextualSearch: true, | ||
// }, | ||
announcementBar: { | ||
id: 'sea-orm-bar', | ||
content: '🚧 SeaORM Pro is in closed beta! If you are interested, please join our <a href="https://forms.office.com/r/gWk7CU9yjV" target="_blank">waiting list</a>. 🚧', | ||
isCloseable: false, | ||
}, | ||
}, | ||
presets: [ | ||
[ | ||
'@docusaurus/preset-classic', | ||
{ | ||
docs: { | ||
sidebarPath: require.resolve('./sidebars.js'), | ||
editUrl: 'https://github.com/SeaQL/seaql.github.io/edit/master/SeaORM-Pro/', | ||
showLastUpdateAuthor: true, | ||
showLastUpdateTime: true, | ||
}, | ||
blog: false, | ||
theme: { | ||
customCss: require.resolve('./src/css/custom.css'), | ||
}, | ||
sitemap: { | ||
changefreq: 'daily', | ||
priority: 0.8, | ||
}, | ||
}, | ||
], | ||
], | ||
scripts: [ | ||
'/sea-ql.js', | ||
], | ||
}; |
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 |
---|---|---|
@@ -0,0 +1,45 @@ | ||
{ | ||
"name": "sea-orm-pro", | ||
"version": "0.0.0", | ||
"private": true, | ||
"scripts": { | ||
"docusaurus": "docusaurus", | ||
"start": "docusaurus start", | ||
"build": "docusaurus build", | ||
"swizzle": "docusaurus swizzle", | ||
"deploy": "docusaurus deploy", | ||
"clear": "docusaurus clear", | ||
"serve": "docusaurus serve", | ||
"write-translations": "docusaurus write-translations", | ||
"write-heading-ids": "docusaurus write-heading-ids" | ||
}, | ||
"dependencies": { | ||
"@docusaurus/core": "^2.4.3", | ||
"@docusaurus/preset-classic": "^2.4.3", | ||
"@docusaurus/theme-common": "^2.4.3", | ||
"@mdx-js/react": "^1.6.21", | ||
"@svgr/webpack": "^5.5.0", | ||
"clsx": "^1.1.1", | ||
"file-loader": "^6.2.0", | ||
"prism-react-renderer": "^1.2.1", | ||
"prismjs": "^1.23.0", | ||
"react": "^17.0.1", | ||
"react-dom": "^17.0.1", | ||
"react-icons": "^5.4.0", | ||
"react-slick": "^0.29.0", | ||
"slick-carousel": "^1.8.1", | ||
"url-loader": "^4.1.1" | ||
}, | ||
"browserslist": { | ||
"production": [ | ||
">0.5%", | ||
"not dead", | ||
"not op_mini all" | ||
], | ||
"development": [ | ||
"last 1 chrome version", | ||
"last 1 firefox version", | ||
"last 1 safari version" | ||
] | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/** | ||
* Creating a sidebar enables you to: | ||
- create an ordered group of docs | ||
- render a sidebar for each doc of that group | ||
- provide next/previous navigation | ||
The sidebars can be generated from the filesystem, or explicitly defined here. | ||
Create as many sidebars as you want. | ||
*/ | ||
|
||
module.exports = { | ||
// By default, Docusaurus generates a sidebar from the docs folder structure | ||
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], | ||
|
||
// But you can create a sidebar manually | ||
/* | ||
tutorialSidebar: [ | ||
{ | ||
type: 'category', | ||
label: 'Tutorial', | ||
items: ['hello'], | ||
}, | ||
], | ||
*/ | ||
}; |
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 |
---|---|---|
@@ -0,0 +1,24 @@ | ||
import React from 'react'; | ||
import clsx from 'clsx'; | ||
import Link from '@docusaurus/Link'; | ||
import styles from './HomepageCompare.module.css'; | ||
|
||
export default function render() { | ||
return ( | ||
<section className={clsx('home-section', 'home-section-alt', styles.features)}> | ||
<div className="container"> | ||
<div className="row"> | ||
<div className={clsx('col col--12')}> | ||
<h2 className="text--center">SeaORM ➕ GraphQL = 🧭 Seaography</h2> | ||
<p className="text--center"> | ||
With <Link to="/docs/seaography/seaography-intro/">Seaography</Link>, you can easily launch a GraphQL server from SeaORM entities! | ||
</p> | ||
<div className="text--center padding-horiz--md"> | ||
<img className={styles.seaography} src="/SeaORM/img/Seaography Screenshot.png"/> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</section> | ||
); | ||
} |
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
/* stylelint-disable docusaurus/copyright-header */ | ||
|
||
.features { | ||
display: flex; | ||
align-items: center; | ||
width: 100%; | ||
} | ||
|
||
.seaography { | ||
width: 100%; | ||
max-width: 1000px; | ||
border-radius: 5px; | ||
} |
Oops, something went wrong.