Skip to content

Commit

Permalink
The best collection, we promise.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertBrunhage committed Dec 2, 2024
1 parent d9b56b7 commit 0f1879b
Show file tree
Hide file tree
Showing 12 changed files with 1,153 additions and 276 deletions.
1 change: 1 addition & 0 deletions .github/scripts/update-readme.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

57 changes: 16 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,23 @@
# Astro Starter Kit: Basics
# Application Download Tracker

```sh
npm create astro@latest -- --template basics
```
A community-maintained list of applications and their download counts. To add your application, please submit a Pull Request.

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
## How to Submit Your Application

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
1. Fork this repository
2. Add your application details to `applications.json`
3. Submit a Pull Request with your changes

![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
Your application entry should include:
- Application name
- Total download count
- (Optional) Brief description
- (Optional) Link to application

## 🚀 Project Structure
## Current Applications

Inside of your Astro project, you'll see the following folders and files:
The list below is automatically generated from applications.json:

```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```

To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| 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 |

## 👀 Want to learn more?

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
<!-- APPLICATIONS_LIST_START -->
<!-- This section is automatically updated by GitHub Actions -->
<!-- APPLICATIONS_LIST_END -->
19 changes: 19 additions & 0 deletions applications.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"applications": [
{
"appName": "Weather App",
"creator": "John Smith",
"description": "A real-time weather application that shows current conditions and forecasts"
},
{
"appName": "Task Manager",
"creator": "Jane Doe",
"description": "A full-stack task management application with user authentication"
},
{
"appName": "Recipe Finder",
"creator": "Mike Johnson",
"description": "Search and save your favorite recipes with this interactive application"
}
]
}
6 changes: 5 additions & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,9 @@
// @ts-check
import { defineConfig } from 'astro/config';

import tailwind from '@astrojs/tailwind';

// https://astro.build/config
export default defineConfig({});
export default defineConfig({
integrations: [tailwind()]
});
Loading

0 comments on commit 0f1879b

Please sign in to comment.