weather-octopus

KO | EN

gitlite — search

#react #ai #llm #android #rust #macos #java #windows #cli #kubernetes #vue #awesome-list #pytorch #ios

weather-octopus

(★ 12)

Hi there! Just a weather forecast by an octopus 🐙

weather-octopus 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="https://weather-octopus.web.app/" target="_blank">
 <img src="https://i.postimg.cc/652yzZS1/weather-octopus.png" width="350" />
 </a>


 Hi there! Just a weather forecast by an octopus 🐙 
 See it in action <a href="https://weather-octopus.web.app/" target="_blank">here</a> 🔥

## Builded with:

- [React](https://es.reactjs.org/) _(Hooks)_
- [TypeScript](https://www.typescriptlang.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [Axios](https://github.com/axios/axios)
- [OpenWeatherMap API](https://openweathermap.org/api)
- [usePosition](https://github.com/trekhleb/use-position)
- [Jest](https://jestjs.io/)
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- [Firebase](https://firebase.google.com/)

## Environment Variables:

To run the project locally you will need to set environment variables, which will be secrets ignored by git like API KEYS or related.

For this, create a `.env` file in the root of the project with the following:

```
// OpenWeather API KEY:
REACT_APP_OPENWEATHER_API_KEY = YourApiKeyHere
```

Just replace `YourApiKeyHere` with __your real API KEY__ _(if you don't have any real API KEY, you will have to contact the project owner to get the secret)_.

This file is already set to be ignored by git in `.gitignore`, and will be also the place to store and hide any new secret that should not be commited. Just remember to add any new secret here in the above `.env` file reference to keep the list of required enviroment variables up to date.

## Deployment:

The project is hosted in firebase, for deploy you will have to install [Firebase Cli](https://github.com/firebase/firebase-tools).

With the [Firebase Cli](https://github.com/firebase/firebase-tools) installed, and the correct access to the project in the Firebase Console, you just will need to run `yarn build` to generate a production build folder, and after that, `firebase deploy` to deploy the build.

The project will be deployed in [https://weather-octopus.web.app/](https://weather-octopus.web.app/) and [https://weather-octopus.firebaseapp.com/](https://weather-octopus.firebaseapp.com/).

## Project Structure:

```

weather-octopus
│
│ -> public (index.html, manifest.json, etc)
│
│ .env <-- (To hide secrets. It's required to run the project locally.
│ Please read the "Environment Variables" section of the README)
│
│ .gitattributes
│ .gitignore
│ .firebase
│ .firebaserc
│ firebase.json
│ postcss.config.js
│ tailwind.config.js
│ tsconfig.json
│ packgae.json
│ yarn.lock
│ README.md
│
└────> src
 │ -> tests
 │ index.tsx
 │ App.tsx
 │
 └───> components (All stateless and presentational React Functional Components)
 │ -> tests
 │
 └───> containers (All stateful React Components intended as independent modules)
 │ -> tests
 │
 └───> helpers
 │ └───> constants
 │ └───> methods
 │ │ types.ts
 │
 └───> providers (All state providers builded with React API Context and Hooks)
 │ -> tests
 │
 └───> services (All external services, as OpenWeather)
 │
 │
 └───> images
 │ └───> gallery (All images files as .svg or .jpg)
 │ │ index.ts (Exports one only images object)
 │
 └───> styles
 │ main.css (All css generated by tailwind, it should not be edited)
 │ tailwind.css (A place to put custom classes if it's necesary)

```

weather-octopus

weather-octopus 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

weather-octopus

weather-octopus 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README