CineSimile

For All Your Movie Recommendation Needs!

Hacktoberfest Notice

Hacktoberfest 2020 is finally here and we very much welcome your wonderful contributions! You can win a Hacktoberfest T-Shirt as a token of appreciation. Visit https://hacktoberfest.digitalocean.com/ and check out how to contribute to open source and be an open source hero! 😁

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.

Getting Started

Thank you for showing interest in CineSimile, an open sourced platform to find similar movies. Please follow the steps and you'll soon end up being an open source contributor 😎. Please read the CONTRIBUTING document before starting to contribute to this project.

Fork the repository.

Clone the repository to your machine.

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

Install node_modules.
```
$ npm ci
```
Start the React development server.
```
$ npm start
```
Do something amazing (FYI, pick an issue from the issue list, and add a comment stating that you're going to work on it.)

Commit and push the changes.

$ git add .

$ git commit -m "your commit message (make it meaningful and short)"

$ git push origin master

Finally, create a pull request.

🐳 Run through Docker (Optional)

Execute the command below if you have the Docker CLI in your machine or server:
```
docker-compose up
```
Open in your browser.
```
- localhost 
OR 
- 0.0.0.0
```
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

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 🧪

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
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

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! 😁
Good luck with your open source journey.

Happy Hacking! 😁

License

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

Maxgit3/cinesimile