This project uses GitHub's REST API to fetch data from the VueTube repository. You will need to create a GitHub personal access token to use this project. Find out how to create one here
Once you have created your token, create a .env
file in the root of the project and add the following:
GITHUB_TOKEN=YOUR_TOKEN_HERE
IS_PROD=true
Set the value of IS_PROD
to false to mock the output to avoid being rate limited (recommended for development)
Inside of this project, you'll see the following folders and files:
/
āāā 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/Vue components.
Any static assets, like images, can be placed in the public/
directory.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
yarn install |
Installs dependencies |
yarn dev |
Starts local dev server at localhost:3000 |
yarn build |
Build your production site to ./dist/ |
yarn preview |
Preview your build locally, before deploying |
yarn astro ... |
Run CLI commands like astro add , astro heck |
yarn astro -- --help |
Get help using the Astro CLI |