search

sourabhsikarwar / Scene-Movie-Platform

https://scene-movie-platform.vercel.app
MIT License
40 stars 104 forks source link

[Issue]: Missing details for Local Setup in README.md #136

Closed Kalyan-velu closed 1 year ago

Kalyan-velu commented 1 year ago

Description:

The README.md file in the repository does not provide enough details for setting up the project locally. Specifically, it does not mention how to create and configure the .env file with the movie API key details. This can cause confusion and errors for potential contributors who want to run the project on their own machines.

Goals:

The goal of this issue is to update the README.md file with clear and comprehensive instructions for creating and configuring the .env file with the movie API key details. This will make the local setup process easier and more user-friendly for contributors.

Proposed Solution:

The proposed solution is to add more details to the "Getting Started" section in README.md which explains how to clone the repository, install the dependencies, create the .env file, and obtain and set the movie API key details. It will also provide an example of how the .env file should look like.

GirlScript Summer of Code 2023 This issue is part of my contribution to GirlScript Summer of Code 2023. I am open to fixing this issue.

Singhal97dhruv commented 1 year ago

How to get the REACT_APP_API_KEY can u please tell

Kalyan-velu commented 1 year ago

from here http://api.themoviedb.org/

Singhal97dhruv commented 1 year ago

And where would be the location of the env file And please also can you tell what data we have to put in .env file

Kalyan-velu commented 1 year ago

in Root of the project where your package.json exists. in the .env file 

REACT_APP_API_KEY=your moviedb api key
Singhal97dhruv commented 1 year ago

Ok now working thanks a lot.