update Readme
This commit is contained in:
@@ -1,22 +1,21 @@
|
||||
# sv
|
||||
# Open-Meteo Weather Web
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
||||
An open-source, high-performance weather forecast website built with SvelteKit and powered by the [Open-Meteo APIs](https://open-meteo.com/).
|
||||
|
||||
## Creating a project
|
||||
## Goals
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
Our objective is to provide a comprehensive, user-friendly weather platform for end-users. We aim to offer professional-grade weather visualizations and detailed meteorological data while maintaining the transparency and community-driven nature of open-source software.
|
||||
|
||||
```sh
|
||||
# create a new project in the current directory
|
||||
npx sv create
|
||||
## Tech Stack
|
||||
|
||||
# create a new project in my-app
|
||||
npx sv create my-app
|
||||
```
|
||||
- **Framework**: [SvelteKit](https://kit.svelte.dev/)
|
||||
- **Language**: [TypeScript](https://www.typescriptlang.org/)
|
||||
- **Data Source**: [Open-Meteo API](https://open-meteo.com/)
|
||||
- **Visualization**: [Highcharts](https://www.highcharts.com/) (Current, transitioning to a more flexible charting library in the future)
|
||||
|
||||
## Developing
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
||||
Once you've cloned the project and installed dependencies with `npm install`:
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
@@ -34,5 +33,3 @@ npm run build
|
||||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
|
||||
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
||||
|
||||
Reference in New Issue
Block a user