East Africa Mineral Insights (EAMI)

Welcome to the East Africa Mineral Insights (EAMI) GitHub repository! This is a full-stack, multi-page website showcasing the vast mineral resources of Kenya and East Africa.

Table of Contents

• Project Description
• Features
• Technologies Used
• Installation
• Usage
• Contributing
• License

Project Description

• East Africa Mineral Insights (EAMI) is a platform designed to educate and inform users about the mineral wealth of East Africa. The website provides insights into:

  • Locations of mineral deposits
  • Mining processes
  • Transportation networks for minerals
  • Industrial applications of minerals
  • Challenges, such as smuggling
  • Opportunities for legal trade and sustainable development

• This project is built with modern web technologies to ensure an interactive and responsive user experience.

Features

• Mineral Database: Detailed descriptions and locations of minerals in East Africa.
• Interactive Maps: Visual representation of mining areas and transportation routes.
• Educational Content: Information on the extraction processes and industrial uses of minerals.
• Challenges Section: Highlights challenges like illegal mining and smuggling.
• Opportunities: Spotlights potential for legal trade and sustainable development.
• Responsive Design: Optimized for desktop and mobile devices.

Technologies Used

• Frontend
  • Typescript: Ensures type safety and scalable development.
  • React: Component-based UI development for dynamic user interfaces.
  • Tailwind CSS: Utility-first CSS framework for rapid UI design.
  • HTML5 & CSS3: Core web technologies for structure and styling.
  • JavaScript: For interactivity and dynamic content.
  • Vite: Fast development build tool for modern web projects.

Installation

• Follow these steps to set up the project locally:

1. Clone the Repository

git clone https://github.com/stephenombuya/EAMI-Website/tree/main
cd east-africa-mineral-insights

2. Install Dependencies

npm install

3. Start the Development Server

npm run dev

4. Open in Browser

• Visit http://localhost:3000 in your browser to view the project.

Usage

• Navigate through the platform to explore various minerals, their locations, and uses.
• Use the map section for an interactive view of mining locations and transportation routes.
• Learn about the challenges and opportunities in East Africa's mineral industry.

Contributing

We welcome contributions to enhance the EAMI platform! To contribute:

1. Fork the repository.
2. Create a new feature branch:

git checkout -b feature-name

3. Commit your changes:

git commit -m "Description of changes"

4. Push to your branch:

git push origin feature-name

5. Open a pull request on GitHub.

License

This project is licensed under the GNU License.