Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zbhavyai committed Jun 6, 2022
1 parent 7bb05c8 commit 57e0702
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# Movie Search using OMDB API
# Movie Search using OMDB API

A frontend for searching for movies using the [OMDB API](https://www.omdbapi.com/). Check it online at [https://omdb-web-react.netlify.app/](https://omdb-web-react.netlify.app/).

## How to build and run

1. Clone the repository on your machine, or download the zip file

```bash
$ git clone git@github.com:zbhavyai/movie-search-omdb.git
```

2. Add API key to [`.env`](.env) file like below, or in a new file `.env.development`. You can get the API key from [here](http://www.omdbapi.com/apikey.aspx).

```
REACT_APP_OMDB_API_KEY=<YOUR API KEY>
```

3. Install the dependencies

```bash
$ npm install
```

4. To run the development build using the below command. You can launch your browser and visit the default URL `http://localhost:3005`

```
$ npm start
```

0 comments on commit 57e0702

Please sign in to comment.