Skip to content

Starting platform for a Astro project that pulls data from an external API and caches the result. (includes responsive template with Bootstrap)

License

Notifications You must be signed in to change notification settings

pyrrolizin/astro-api-request

Repository files navigation

Welcome to Astro-api-request 👋

Version License: MIT

This project is a starting platform for a Astro project that pulls data from an external API and caches the result. The project includes a responsive Bootstrap template.

✨ Demo (OpenWeatherMap-Api - Current weather in Stuttgart, Germany)

tbd

screenshot of the demo application

Prerequisit

  • Node.js >= 16
  • npm

Install

npm i

Environment varaibles

You can set the following environment variables:

NAME required Comment
API_KEY yes You can get your own free OpenWeatherApi key on this website: https://home.openweathermap.org/users/sign_up

You can either set the environment variables or use the .env file: Make your own copy of the .env file and specify the .env and add the keys.

cp ./.env_default ./.env

Learn more about the OpenWeatherMap API: https://openweathermap.org/api

Getting Started

First, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

🚀 Project Structure

Inside of your Astro 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/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:3000
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 preview
npm run astro --help Get help using the Astro CLI

👀 Want to learn more about astro?

Feel free to check the astro documentation.

About

Starting platform for a Astro project that pulls data from an external API and caches the result. (includes responsive template with Bootstrap)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published