https://github.com/descent098/coderplusplus
Revamping an old test project in a new framework
https://github.com/descent098/coderplusplus
Last synced: 3 months ago
JSON representation
Revamping an old test project in a new framework
- Host: GitHub
- URL: https://github.com/descent098/coderplusplus
- Owner: Descent098
- Created: 2024-07-31T22:41:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-01T09:45:02.000Z (over 1 year ago)
- Last Synced: 2025-03-18T13:48:56.184Z (10 months ago)
- Language: Astro
- Homepage: http://kieranwood.ca/CoderPlusPlus/
- Size: 157 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coder++
I originally created [https://github.com/descent098/Coder](https://github.com/descent098/Coder) years ago for a course I was teaching about static site development. This repo is intended to be an improvement on the base idea of a static site that generates static sites, and is implemented with [Astro](https://astro.build/) ([Documentation](https://docs.astro.build)), [tailwind](https://tailwindcss.com/), [SailboatUI](https://sailboatui.com/).
## 🧞 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 |
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── 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.