Awesome Movies README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Awesome Movies

Welcome to our open-source website repository on GitHub! this website utilizes APIs to provide an interactive platform for visitors to engage with the content and share their thoughts.

🛠 Built With

Client

• HTML

• CSS

• JAVASCRIPT

### Tech Stack

The key technologies and frameworks we utilize includes Front-end Development:

• HTML5: Provides the structure and markup of the website.
• CSS3: Styles the website, ensuring an attractive and responsive design.
• JavaScript: Enables dynamic and interactive elements on the client-side.

Back-end Development:

• Node.js: A runtime environment for executing JavaScript code on the server-side, enabling server-side scripting and handling of requests.

API Integration: Version Control and Deployment:

• Git: A distributed version control system for tracking changes in the codebase and facilitating collaboration among developers.
• GitHub: We host our code repository on GitHub, enabling open-source collaboration, issue tracking, and pull request management.

Key Features

Key Features of this Website

• Commenting System: Our website provides a commenting system that allows visitors to share their thoughts, provide feedback, and engage in discussions. Users can easily write and post comments on various sections of the website, fostering an interactive and collaborative environment.

• Like System: We have implemented a like system that enables users to express their appreciation for specific content. Visitors can simply click on the like button associated with an item, such as a post, image, or video, to indicate their approval or enjoyment.

(back to top)

🚀 Live Demo

• [Live Demo Link]( https://sharminkhan0.github.io/ /)

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Node.js: Ensure that Node.js is installed on your machine. You can download the latest version from the official Node.js website and follow the installation instructions.

webpack: Ensure that webpack is installed on your machine. You can install from the guideline in the official website of webpack

Setup

API Integration: If our website relies on external APIs, make sure you have the required API keys or credentials. Update the relevant API configuration files or environment variables.

Clone this repository to your desired folder:

Example commands:

git clone git@github.com:https://github.comsharminkhan0/JavaScript-capstone-project.git

Install

To install all dependencies, run:

npm install

Usage

Development Mode: To run the website in development mode, use the command "npm run dev". This will start the development server and enable hot-reloading, allowing you to view changes instantly as you edit the code. Production Build: When you are ready to build the production-ready version of the website, run the command "npm run build". This will generate the optimized and minified assets in the dist or build directory. Start the Server: To start the production server and serve the built assets, use the command "npm start"..

Run tests

Testing Framework: If our project includes tests, make sure you have the necessary testing framework (e.g., Jest) installed globally or as a project dependency. Test Execution: Use the command "npm test" to run the tests and verify the functionality of the website. The test results will be displayed in the terminal.

You can also use the following command.

  npm install --save-dev jest
  npm install --save-dev @babel/plugin-transform-modules-commonjs
  npm install --save-dev jest-environment-jsdom
  npm install jquery
  npm install --save-dev identity-obj-proxy
  npm test

(back to top)

### Deployment

Hosting Platform: Choose a hosting platform that suits your needs (e.g., Heroku, AWS, Netlify). Deployment Configuration: Set up the deployment configuration, such as configuring the server, environment variables, and build commands. Deployment Process: Follow the hosting platform's documentation to deploy your website. This may involve connecting the repository, specifying the deployment branch, and triggering the deployment process.

(back to top)

👥 Authors

👤 Sharmin Akter Khan

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

This website will contain more animations in the future, providing a fully responsive design for optimal user experience.

• Animated Logo
• Animated Buttons

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please feel free to contribute to this project if you enjoy it, and don't forget to star the repository so that it may be seen by more people.

(back to top)

🙏 Acknowledgments

As well as Freecodecamp and w3school for their useful articles that assisted me in creating this project, I would like to thank Microverse for their innovative approach to teaching me how to code.

(back to top)

• How to build this website?

  • Follow the steps in this link https://github.com/microverseinc/curriculum-javascript/blob/main/group-capstone/js_capstone.md

📝 License

This project is MIT licensed.

(back to top)