Skip to content

Commit

Permalink
Read me file
Browse files Browse the repository at this point in the history
  • Loading branch information
lunargravity committed Aug 7, 2024
1 parent 58f8b5c commit cd92050
Showing 1 changed file with 23 additions and 59 deletions.
82 changes: 23 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,34 @@
# Getting Started with Create React App
# Weather Application

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This is a basic weather web application that shows you the weather for the current week in any desired city in the world with a list of events that are happening in that city. The weather information is powered by both OpenWeather API and OpenCage Geocoding API. Events list is generated by Ticketmaster API. Users can also store their favorite cities with a click of a button.

## Available Scripts
## Deployment

In the project directory, you can run:
Clone the repository:

### `npm start`
```bash
git clone https://github.com/lunargravity/weather-app.git
```

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
Install dependencies:

The page will reload when you make changes.\
You may also see any lint errors in the console.
```bash
npm install
```

### `npm test`
Start development server:

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
```bash
npm start
```

### `npm run build`
Open your browser and navigate to `http://localhost:3000`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
## Features

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
- Search bar for cities in the world
- Seven day weather forecast
- Both fahrenheit and celsius weather toggle
- Display local time
- Events in the area using Ticketmaster
- Favorite cities storage

0 comments on commit cd92050

Please sign in to comment.