Skip to content

Latest commit

 

History

History
201 lines (151 loc) · 7.01 KB

README.md

File metadata and controls

201 lines (151 loc) · 7.01 KB

Contributors Forks Stargazers MIT License


Bollywood-Back

Discover the Bollywood movie that were popular when you were born

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Screenshot

Just enter your birth date and you have a movie that was popular on the date you entered along with a youtube search for the trailer of the movie.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • React
  • NodeJS
  • TailwindCSS

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need the following software.

  • npm 
    npm install npm@latest -g

Installation

Below are the instructions to setup the project locally , don't forget to Cd to the respective folders mentioned.

  1. Get a free API Key at TMDB and YT api key at YT
  2. Clone the repo 
    git clone https://github.com/utsav82/Bollywood-Back.git
  3. Install NPM packages in the Server and Client folders 
    npm install
  4. Create a '.env' in Server folder and enter your API according to the sample '.env' template 
    API_KEY = "ENTER YOUR API";
  5. Start the Nodemon server in Server folder 
    npm run start:dev
  6. Start the frontend in client folder 
    npm run dev

(back to top)

Roadmap

  • Add Readme
  • Add footer
  • Allow input through calendar
  • Make the site responsive (form and footer left)
  • Deploy
  • Add multiple results
  • ui features like hue,tooltip and improve frontend

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Utsav Yadav - @Yadavutsav3 Malay Kumar - @void_MalayK

Project Link: https://github.com/Utsav82/Bollywood-Back

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)