Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add new readme file info.
  • Loading branch information
luis-grizzo committed Jul 3, 2024
1 parent 552b3ab commit 30a4268
Showing 1 changed file with 42 additions and 23 deletions.
65 changes: 42 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,55 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
<div align="center">
<img src="./src/app/opengraph-image.jpg">

<h1>☀ Check Weather</h1>

<p>Consult your local weather info!</p>

## Getting Started
<a href="https://go-check-weather.vercel.app" target="_blank">Access the app</a>
</div>

First, run the development server:
---

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
## 🛠️ Stack

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- [React.js](https://react.dev/)
- [Next.js](https://nextjs.org/)
- [Tailwindcss](https://tailwindcss.com/)
- [Framer Motion](https://www.framer.com/motion/)
- [Jest](https://jestjs.io/)

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## 💭 Motivation
Check Weather is a Progressive Web App (PWA) that provides current weather forecasts based on the user's location.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
Its main objective is to serve as a study project for front-end development. In this project, I explored the caching functionality of server-side generated pages using Next.js to provide forecasts for as many locations as possible while minimizing the consumption of the OpenWeather API. Additionally, I studied the configuration of CI workflows on GitHub to execute tests on new pull requests.

## Learn More
## ✅ Prerequisites
Make sure you have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed.

To learn more about Next.js, take a look at the following resources:
## 💻 Run project
1. Clone repository:
```sh
git clone https://github.com/luis-grizzo/check-weather.git
```

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
2. go to project directory:
```sh
cd check-weather
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
3. Install dependencies:
```sh
yarn install
```

## Deploy on Vercel
4. Run development server:
```sh
yarn dev
```

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## :memo: License
This project is under the MIT license. See [LICENSE](https://github.com/luis-grizzo/new-challenge-trinca/blob/main/LICENSE) for more information.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
---

👨‍🦱 Developed by **Luís Grizzo** - **Contact:** <a href="https://www.linkedin.com/in/luis-grizzo/">Linkedin</a>

0 comments on commit 30a4268

Please sign in to comment.