Skip to content

Commit

Permalink
Added the project description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
hmdNetizen committed Jul 9, 2021
1 parent d431d4e commit d093e1d
Showing 1 changed file with 71 additions and 26 deletions.
97 changes: 71 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,91 @@
# Getting Started with Create React App
<!-- Please update value in the {} -->

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
<h1 align="center">Weather Previewer App</h1>

## Available Scripts
<div align="center">
Solution for a challenge from <a href="http://devchallenges.io" target="_blank">Devchallenges.io</a>.
</div>

In the project directory, you can run:
<div align="center">
<h3>
<a href="https://hmdnetizen-weather-app.netlify.app/">
Demo
</a>
<span> | </span>
<a href="https://github.com/hmdNetizen/weather-app">
Solution
</a>
<span> | </span>
<a href="https://devchallenges.io/challenges/mM1UIenRhK808W8qmLWv">
Challenge
</a>
</h3>
</div>

### `npm start`
<!-- TABLE OF CONTENTS -->

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Table of Contents

The page will reload if you make edits.\
You will also see any lint errors in the console.
- [Overview](#overview)
- [Built With](#built-with)
- [Features](#features)
- [How to use](#how-to-use)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)

### `npm test`
<!-- OVERVIEW -->

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.
## Overview

### `npm run build`
![screenshot](https://i.imgur.com/HoMGZHo.gif)

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
Introduce your projects by taking a screenshot or a gif. Try to tell visitors a story about your project by answering:

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
- [Demo](https://hmdnetizen-weather-app.netlify.app/)
- This project really helps me in solidifying my Typescript knowledge.

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

### `npm run eject`
<!-- This section should list any major frameworks that you built your project using. Here are a few examples.-->

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
- [Typescript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)
- [Redux](https://redux.js.org/)
- [Sass](https://sass-lang.com/)

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.
## Features

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.
<!-- List the features of your application or follow the template. Don't share the figma file here :) -->

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.
This application/site was created as a submission to a [DevChallenges](https://devchallenges.io/challenges) challenge. The [challenge](https://devchallenges.io/challenges/mM1UIenRhK808W8qmLWv) was to build an application to complete the given user stories.

## Learn More
## How To Use

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

To learn React, check out the [React documentation](https://reactjs.org/).
To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash
# Clone this repository
$ git clone https://github.com/your-user-name/your-project-name

# Install dependencies
$ npm install

# Run the app
$ npm start
```

## Acknowledgements

<!-- This section should list any articles or add-ons/plugins that helps you to complete the project. This is optional but it will help you in the future. For example: -->

- [Steps to replicate a design with only HTML and CSS](https://devchallenges-blogs.web.app/how-to-replicate-design/)
- [Node.js](https://nodejs.org/)
- [Marked - a markdown parser](https://github.com/chjj/marked)

## Contact

- Website [My Portfolio](https://hameed-jimoh.vercel.app)
- GitHub [@hmdNetizen](https://{github.com/hmdNetizen})
- Twitter [@hmdNetizen](https://{twitter.com/hmdNetizen})

0 comments on commit d093e1d

Please sign in to comment.