Skip to content

ln0185/SagnirV2

Repository files navigation

SAGNIR V2

Icelandic Folklore App

This project is an interactive application that brings Icelandic folklore to life. Built using React, NextJS, TypeScript, and Tailwind CSS, the app includes a variety of features designed to immerse users in the rich tapestry of Iceland's mythical stories.

Features

📜 Stories Page

  • Explore a collection of captivating Icelandic folklore stories.
  • Stories are dynamically generated from a custom API, developed specifically for this project, ensuring a unique and authentic experience.

🔍 Search Bar

  • Quickly search through the stories to find your favorite myths and legends.
  • Responsive and intuitive, making it easy to find content.

🗺️ Interactive Map

  • A Leaflet-powered map showcasing key locations tied to the stories.
  • Features include:
    • Custom cartographic overlay style to provide a distinct and immersive aesthetic.
    • Pop-ups on special locations that display related stories.
    • Geolocation support, enabling users to view their position relative to the map's folklore landmarks.

Quiz Page

  • Test your knowledge of Icelandic folklore with a fun and engaging quiz.
  • Interactive feedback keeps users entertained while learning.

Technology Stack

  • React: Component-based UI framework.
  • NextJS: Fast and optimized development environment and API fetching.
  • TypeScript: Ensures type safety and improves code quality.
  • Tailwind CSS: Enables rapid styling with utility-first classes.
  • Leaflet: For rendering the interactive map.

Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.qkg1.topln0185/SagnirV2/.git
    cd sagnirV2
    
  2. Install dependencies:

    bash
    
    
    npm install
    

Running the Application

  1. Start the development server:

    bash
    
    npm run dev
    
  2. Open your browser and navigate to http://localhost:3000.

Map Configuration

  • The map is rendered using Leaflet, with custom styling provided by a cartographic overlay.
  • Locations of interest are preloaded and linked to corresponding stories via pop-ups.
  • Geolocation is enabled to enhance user engagement.

Deployment

  1. Build the project

    bash
    
    npm run build
    
  2. Serve the dist/ directory using a static file server or deploy to a platform like Vercel, Netlify, or GitHub Pages.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.


Happy exploring the myths and legends of Iceland! 🌋

About

Sagnir is an app delivering real Icelandic folklore stories in Icelandic using react, typescript and tailwind as well as custom API & leaftlet API. It has an interactive map and quiz features. It is made with React TS and NextJS

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors