CineSimile

For All Your Movie Recommendation Needs and the Movie Lovers Greed!

Hacktoberfest 2021 Notice

Hacktoberfest 2021 is finally here and we very much welcome your wonderful contributions! You can earn a Hacktoberfest T-Shirt as a reminder of your efforts and as a token of appreciation. Visit Hacktoberfest and check out how to contribute to open source and become an open source hero! 😁 Hacktoberfest is a month-long celebration of open source software run by DigitalOcean. During the month of October, they invite us to join open-source software enthusiasts, beginners, and the developer community by contributing to open-source projects.

About The Project

CineSimile is a platform where you can find similar movies for a given movie. Currently, we are in the phase of finding similarity between the movies. So keep in touch, and we'll let you know.

Machine Learning

Cinesmile is powered by machine learning to enhance the search capabilities and find a closer fit to your movie of choice. Similar technology is used by Netflix and Youtube to tailor recommendations to your personal choices.

Technology Used

• Carbon Design System - https://www.carbondesignsystem.com/all-about-carbon/what-is-carbon

• React - https://reactjs.org/

• Docker - https://www.docker.com/why-docker

Getting Started

Thank you for showing interest in CineSimile, an open sourced platform to find similar movies for a given movie. Please follow the steps and you'll soon end up being an open source contributor and become a part of the Open Source Community😎. Please read the CONTRIBUTING document before starting to contribute to this project and learn about the intricacies of Contributing.

1. Fork the repository.

2. Clone the repository to your Local machine.

   $ git clone https://github.com/<username>/cinesimile.git

3. Install node_modules.

   $ npm ci

4. Start the React development server.

   $ npm start

5. Do something amazing and Creative(FYI, pick an issue from the issue list, and add a comment stating that you're going to work on it.)

6. Commit and push the changes.

   $ git add .
   
   $ git commit -m "your commit message (make it meaningful and short)"
   
   $ git push origin master

7. Finally, create a pull request.

🐳 Run through Docker (Optional)

If interested in learning more about docker. Docker Introduction

1. Execute the command below if you have the Docker CLI in your machine or server:

   docker-compose up

2. Open in your browser.

   - localhost
   OR
   - 0.0.0.0

3. Access the portainer to see the logs (optional)

   - localhost:9000
   OR
   - 0.0.0.0:9000

   Do the follow steps to use the Portainer:

   1. You'll need to create a password for local admin account.
   2. Choose the option: "Docker manage the local Docker environment".
   3. Done, you're now able to manage the containers

Additional Information

9. If you are creating a new pull request please update your fork.

   $ git pull upstream master

Do this before creating another pull request. By doing this, your fork will be up-to-date with the main repository.

Running E2E Tests 🧪

1. Running Tests Manually Using Cypress Test Runner

   npm run cy:run_in_dev

   Note: If the app server is already running, run: npm run cy:open

2. Running All Tests in Headless Mode

    npm run cy:run_in_ci

   Note: If the app server is already running, run: npm run cy:run

3. Running Specific Test in Headless Mode

   // replace <test_name> with the test file name
   
   npm run cy:run --spec "cypress/integration/<test_name>.spec.js"

Spread the word, help your friends to get a Hacktoberfest T-Shirt too and being a of the amazing Open Source Community ! 😁
Good luck with your open source journey.

Happy Hacking!! 😁

License

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