/calenderific

Calenderific is a web application that provides information about holidays in different countries around the world. It allows users to explore holidays by country and view details of individual holidays.

Primary LanguageJavaScriptMIT LicenseMIT

📗 Table of Contents

📖 [Calenderific]

[Calenderific] is a web application that provides information about holidays in different countries around the world. It allows users to explore holidays by country and view details of individual holidays.

🛠 Built With

Tech Stack

Client
Technologies

Key Features

  • [List_feature] - View a list of countries with their respective holidays
  • [Search_feature] - Search for a specific country
  • [View_details_feature] - View details of holidays in a selected country

🚀 Live Demo

Below are important links to live project .

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  • A code editor (preferably VSCode)
  • A browser
  • Node.js (version 12 or higher to run javascript files locally)
  • LiveServer (to load javascript modules)
  • npm (version 6 or higher) or Yarn (version 1.22 or higher)

Setup

Clone this repository to your desired folder:

  • Open git bash on local computer
  • clone the repo with:

git clone from https://github.com/0sugo/calenderific.git

Install

Install this project with:

  • run cd calenderific to enter the project folder
  • run npm i to install all dependencies

Usage

To run the project, execute the following command:

  • run npm start to launch the application
  • enjoy application

Run tests

To run tests, run the following command:

  • run npm test
  • Enjoy the green checkmarks

👥 Authors

👤 JOSECK OSUGO

🔭 Future Features

  • [Holiday_reminders]
  • [Add_more_Countries]
  • [Social_sharing]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner at first attempt. Keep going!

🙏 Acknowledgments

This web design was inspired by Nelson Sakwa on this idea.

I'm thankful to Microverse for providing a study platform which guided me through this project

📝 License

This project is MIT licensed.

(back to top)