Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.72 KB

README.md

File metadata and controls

80 lines (60 loc) · 2.72 KB
Raw

FE hunger games

Community-driven game focusing on front-end development, where participants collaborate to create the most polished code for simple UI blocks.

Requirements

  • node 18
  • npm 9.8.1
  • docker 24+

Initial setup (for local development)

  1. Make all scripts executable and run the setup-env script which will create the app's docker image
$ chmod u+x ./bin/*
$ ./bin/setup-env.sh
  1. Install dependencies
$ ./bin/run-command.sh npm i
  1. Run the app in dev mode (make sure port 4321 is free on your machine)
$ ./bin/start.sh

Build (for production)

$ ./bin/run-command.sh npm run build

if you want to preview the changes (make sure port 4322 is free on your machine)

$ ./bin/run-command.sh npm run preview

🚀 Project Structure

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

├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.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.

The src/content/ directory contains "collections" of related Markdown and MDX documents. Use getCollection() to retrieve posts from src/content/blog/, and type-check your frontmatter using an optional schema. See Astro's Content Collections docs to learn more.

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?

Check out our documentation or jump into our Discord server.

Credit

This theme is based off of the lovely Bear Blog.