README.md

NALOXONE MAP

Find a kit. Save a life.

Website ⭐

Live Demo of intial prototype we worked of off

Live Demo of the current working version

Purpose

A map that guides bystanders at the scene of an overdose to the nearest naloxone kit, and walks them through what to do.

Website Layout

• Landing Page:
  • index.html
• Emergency:
  • step1.html
  • Step2.html
  • map.html
  • Step4.html
  • add-kit.html
• FAQ:
  • faq.html

Getting Started 🤔

How to Run Locally

Requirements 🐶

• git
• Node.js
• npm (Installed with Node.js)

1. Once you have git installed, copy this link: https://github.com/hightechu/hightechu-academy-victorianaloxonemap.git
2. open the command line, type git clone and paste the link
3. on the command line move into the project directory
4. run npm install
5. run node .
6. Head over to http://localhost:3000 and your copy of the site should be up!

📤 Contributing There are two main ways in which you can participate in the project:

• Submit bugs and feature requests
• Contribute to the code base through source code changes
• Learn more in our Contributing Document

Code of Conduct 📜

Naloxone Map abides by the CNCF code of conduct. Here is an excerpt:

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

Resources 📘

• GitHub
• GitHub Help
• GitHub Markdown Help
• GIT Command Line Cheat Sheet
• Mapbox Documentation
• Firebase Documentation

Licence ⚖️

This project uses the MIT Licence