Skip to content

Commit b60cd89

Browse files
committed
feat: add read me
1 parent 2b80c88 commit b60cd89

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

README.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,42 @@
1-
# Astro Starter Kit: Basics
1+
# Devmotion Landing Page
22

3-
```sh
4-
npm create astro@latest -- --template basics
5-
```
6-
7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
3+
The official repository for the Devmotion landing page.
104

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
> Built with [Astro🚀](https://astro.build)
126
13-
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
7+
![Paige preview](https://raw.githubusercontent.com/Dev-Motion/.github/main/assets/devmotion-preview.png)
148

159
## 🚀 Project Structure
1610

17-
Inside of your Astro project, you'll see the following folders and files:
11+
Inside repository, you'll see the following folders and files:
1812

1913
```text
2014
/
21-
├── public/
22-
│ └── favicon.svg
23-
├── src/
24-
├── components/
25-
│ └── Card.astro
26-
├── layouts/
27-
│ └── Layout.astro
28-
└── pages/
29-
└── index.astro
30-
└── package.json
15+
├───.vscode
16+
├───public
17+
└───src
18+
├───assets
19+
│ └───images
20+
├───components
21+
├───icons
22+
├───layouts
23+
├───pages
24+
└───utils
3125
```
3226

3327
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
3428

35-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
29+
The `src/components/` directory for our components. Astro uses the [Snowpack](https://www.snowpack.dev/) module bundler, which means that each component is its own module. This allows us to use the same component in multiple pages without worrying about collisions.
30+
31+
The `src/layouts/` directory contains the layout components for our site. Layouts are special components that wrap other components, and are used to create a consistent layout across multiple pages.
32+
33+
The `src/assets/` directory is where we keep our static assets like images.
34+
35+
The `src/utils/` directory is where we keep our utility functions. These are functions that are used across multiple components, like a function that lets you create class names conditionally while merging of tailwind classes when needed.
36+
37+
The `src/icons/` directory is where we keep our SVG icons. These icons are used across multiple components and are automatically optimized by the `astro-icon` library.
3638

37-
Any static assets, like images, can be placed in the `public/` directory.
39+
Any static assets that doesn't need optimization, like favicon, can be placed in the `public/` directory.
3840

3941
## 🧞 Commands
4042

@@ -49,6 +51,6 @@ All commands are run from the root of the project, from a terminal:
4951
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
5052
| `npm run astro -- --help` | Get help using the Astro CLI |
5153

52-
## 👀 Want to learn more?
54+
## Contributing
5355

54-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
56+
If you want to contribute to this project, please read the [CONTRIBUTING.md](#) file.

0 commit comments

Comments
 (0)