-
Notifications
You must be signed in to change notification settings - Fork 146
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
1 changed file
with
83 additions
and
39 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,54 +1,98 @@ | ||
| # Astro Starter Kit: Basics | ||
| <br> | ||
|
|
||
| ```sh | ||
| npm create astro@latest -- --template basics | ||
| ``` | ||
| <p align="center"> | ||
| <a href="https://surrealdb.com#gh-dark-mode-only" target="_blank"> | ||
| <img width="300" src="/img/white/logo.svg" alt="SurrealDB Logo"> | ||
| </a> | ||
| <a href="https://surrealdb.com#gh-light-mode-only" target="_blank"> | ||
| <img width="300" src="/img/black/logo.svg" alt="SurrealDB Logo"> | ||
| </a> | ||
| </p> | ||
|
|
||
| [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) | ||
| [](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) | ||
| [](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) | ||
| <h3 align="center"> | ||
| <a href="https://surrealdb.com#gh-dark-mode-only" target="_blank"> | ||
| <img src="/img/white/text.svg" height="15" alt="SurrealDB"> | ||
| </a> | ||
| <a href="https://surrealdb.com#gh-light-mode-only" target="_blank"> | ||
| <img src="/img/black/text.svg" height="15" alt="SurrealDB"> | ||
| </a> | ||
| is the ultimate cloud <br> database for tomorrow's applications | ||
| </h3> | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
| <h3 align="center">Develop easier. Build faster. Scale quicker.</h3> | ||
|
|
||
|  | ||
| <br> | ||
|
|
||
| ## 🚀 Project Structure | ||
| <p align="center">The documentation for <a href="https://github.com/surrealdb/surrealdb" target="_blank">SurrealDB</a>, built using <a href="https://docusaurus.io/" target="_blank">Docusaurus</a>.</p> | ||
|
|
||
| Inside of your Astro project, you'll see the following folders and files: | ||
| <p align="center">If you want to contribute, then please read the <a href="https://github.com/surrealdb/awesome-surreal/blob/main/CONTRIBUTING.md" target="_blank">contributing guidelines</a>.</p> | ||
|
|
||
| ```text | ||
| / | ||
| ├── public/ | ||
| │ └── favicon.svg | ||
| ├── src/ | ||
| │ ├── components/ | ||
| │ │ └── Card.astro | ||
| │ ├── layouts/ | ||
| │ │ └── Layout.astro | ||
| │ └── pages/ | ||
| │ └── index.astro | ||
| └── package.json | ||
| ``` | ||
| <br> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://surrealdb.com/discord"><img src="https://img.shields.io/discord/902568124350599239?label=discord&style=flat-square&color=5a66f6"></a> | ||
| | ||
| <a href="https://twitter.com/surrealdb"><img src="https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=flat-square"></a> | ||
| | ||
| <a href="https://dev.to/surrealdb"><img src="https://img.shields.io/badge/dev-join_us-86f7b7.svg?style=flat-square"></a> | ||
| | ||
| <a href="https://www.linkedin.com/company/surrealdb/"><img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square"></a> | ||
| | ||
| <a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img src="https://img.shields.io/badge/youtube-subscribe-ff0000.svg?style=flat-square"></a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://surrealdb.com/blog"><img height="25" src="/img/social/blog.svg" alt="Blog"></a> | ||
| | ||
| <a href="https://github.com/surrealdb/surrealdb"><img height="25" src="/img/social/github.svg" alt="Github "></a> | ||
| | ||
| <a href="https://www.linkedin.com/company/surrealdb/"><img height="25" src="/img/social/linkedin.svg" alt="LinkedIn"></a> | ||
| | ||
| <a href="https://twitter.com/surrealdb"><img height="25" src="/img/social/twitter.svg" alt="Twitter"></a> | ||
| | ||
| <a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img height="25" src="/img/social/youtube.svg" alt="Youtube"></a> | ||
| | ||
| <a href="https://dev.to/surrealdb"><img height="25" src="/img/social/dev.svg" alt="Dev"></a> | ||
| | ||
| <a href="https://surrealdb.com/discord"><img height="25" src="/img/social/discord.svg" alt="Discord"></a> | ||
| | ||
| <a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="25" src="/img/social/stack-overflow.svg" alt="StackOverflow"></a> | ||
| </p> | ||
|
|
||
| <br> | ||
|
|
||
| ## Getting started with SurrealDB | ||
|
|
||
| Visit [surrealdb.com/docs](https://surrealdb.com/docs/surrealdb/) to get started with SurrealDB. | ||
|
|
||
| ## Contributing to the documentation | ||
|
|
||
| Please see our [contributing guidelines](/CONTRIBUTING.md). | ||
|
|
||
| Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. | ||
| ### Good First Issues | ||
|
|
||
| There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. | ||
| We have a list of [good first issues](https://github.com/surrealdb/docs.surrealdb.com/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process. | ||
|
|
||
| Any static assets, like images, can be placed in the `public/` directory. | ||
| ### Installation | ||
|
|
||
| ## 🧞 Commands | ||
| To get started with contributing to the SurrealDB documentation, first install the required packages using the following command. | ||
|
|
||
| All commands are run from the root of the project, from a terminal: | ||
| ``` | ||
| $ pnpm install | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| | Command | Action | | ||
| | :------------------------ | :----------------------------------------------- | | ||
| | `npm install` | Installs dependencies | | ||
| | `npm run dev` | Starts local dev server at `localhost:4321` | | ||
| | `npm run build` | Build your production site to `./dist/` | | ||
| | `npm run preview` | Preview your build locally, before deploying | | ||
| | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | ||
| | `npm run astro -- --help` | Get help using the Astro CLI | | ||
| The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ## 👀 Want to learn more? | ||
| ``` | ||
| $ pnpm start | ||
| ``` | ||
|
|
||
| Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). | ||
| ### Building | ||
|
|
||
| The following command builds and generates static content into the `build` directory, and can then be served using any static contents hosting service. | ||
|
|
||
| ``` | ||
| $ pnpm build | ||
| ``` |