Skip to content

Latest commit

 

History

History
325 lines (226 loc) · 9.28 KB

README.md

File metadata and controls

325 lines (226 loc) · 9.28 KB

logo

SciMovies

Table of Contents 📋

SciMovies 📖

SciMovies SciMovies is a single page application that display a list of epic scifi movies.

Built With 🛠

Tech Stack 🗜️

Client
  • HTML5 markup to build raw structure of this web page

  • CSS3 custom properties, FlexBox, Grid to make the website visually attractive

  • Javascript

  • Linters for coding convention and coding formating
Javascript runtime environment
  • Node JS as a javascript runtime machine [git], a free and open source distributed version control system
Deployment
Bundler
Version Control
Backend


Key Features 🏷️

  • List of Movies
  • Like a movie
  • Display movie likes
  • Add comments on movies

(back to top)


Live Demo 🚀

Live Demo Link

(back to top)

Project Demo 🏁

Project Demo

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


Setup ⚙️

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/RileyManda/SciMovies.git
  • Navigate to the folder
cd my-folder
  • Checkout the branch
git checkout main


Install 🏗️

Install all dependencies:

    npm install


Usage 📂

To run the project, follow these instructions:

  • You have to clone this repo to your local machine.
git clone https://github.com/RileyManda/SciMovies.git


Run tests 🧪

How should it be tested? To run tests, run the following command:

  • HTML linter errors run:
npx hint . --fix
  • CSS linter errors run:
npx stylelint "**/*.{css,scss}" --fix
  • JavaScript linter errors run:
npx eslint . --fix
  • For unit testing, run:
npm test


Deployment

This project was deployed using GitHub Pages. For more information about how to use GitHub pages read here 🤩.

If you want to watch a video about how to use GitHub pages instead of reading click here ☺️.

(back to top)


👥 Authors

👤 Riley Manda

Much appreciation to Evelyne Celyne Birungi for Implementing the header:

👤 Evelyne Celyne Birungi

(back to top)


Future Features 🔭

  • Improve the UI with animations
  • Project UI Styling
  • Testing with test

(back to top)


👥 Attribution

Contributing 🤝

If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an issue on GitHub. Remember, every contribution, no matter how big or small, makes a difference.

(back to top)


Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

  • Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

  • Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

  • Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)


Acknowledgments 🙏

I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.

(back to top)


FAQ ❓

  • Question_1 Do I have to use the vs code specifically?
    • Answer_1 You can use any code editor of your choice.
  • Question_2 Where can I download node JS for installation?

(back to top)

License 📝

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)