Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke-Oldenburg committed Aug 31, 2024
1 parent b7bd770 commit a0c156a
Showing 1 changed file with 6 additions and 45 deletions.
51 changes: 6 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,8 @@
# Astro Starter Kit: Minimal
# Back on Track America Website
This repo contains the website code for the nonprofit Back on Track America. Back on Track is a nonprofit dedicated to serving the homeless and defeating food insecurity. This website is currently being ported to Astro from Wix because it was far too expensive to host.

```sh
npm create astro@latest -- --template minimal
```
# Contributing
In order to test the site, just run `npm run dev` in the terminal. Any changes that would benefit the quality of the site are welcomed. Look for features / issues on the [project](https://github.com/orgs/backontrackus/projects/2).

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

> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
## πŸš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

```text
/
β”œβ”€β”€ public/
β”œβ”€β”€ src/
β”‚ └── pages/
β”‚ └── index.astro
└── package.json
```

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

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 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).
# License
The Back on Track America website is released under the [GPL-3.0 license](LICENSE).

0 comments on commit a0c156a

Please sign in to comment.