Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/priyam-03/disaster-inventory
Incident Map is a web application that visualizes incidents on an interactive map of India. Users can filter incidents by state, month, and year, making it easier to analyze and track data over time. Built with Next.js, TypeScript, Prisma, TailwindCSS, and MongoDB, this project showcases a full-stack implementation of modern web technologies.
https://github.com/priyam-03/disaster-inventory
caching mongodb nextjs openstreetmap prisma server-actions tailwindcss typescript
Last synced: 2 months ago
JSON representation
Incident Map is a web application that visualizes incidents on an interactive map of India. Users can filter incidents by state, month, and year, making it easier to analyze and track data over time. Built with Next.js, TypeScript, Prisma, TailwindCSS, and MongoDB, this project showcases a full-stack implementation of modern web technologies.
- Host: GitHub
- URL: https://github.com/priyam-03/disaster-inventory
- Owner: priyam-03
- License: mit
- Created: 2024-08-07T17:45:13.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-21T05:34:04.000Z (3 months ago)
- Last Synced: 2024-10-13T00:44:19.848Z (2 months ago)
- Topics: caching, mongodb, nextjs, openstreetmap, prisma, server-actions, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://disaster-inventory.vercel.app
- Size: 2.77 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Landslides Map
Incident Map is a web application that visualizes incidents on a map, allowing users to filter incidents by state, month, and year. The project is built using Next.js, TypeScript, Prisma, TailwindCSS, and MongoDB.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Setup Instructions](#setup-instructions)
- [Environment Variables](#environment-variables)
- [Running the Project](#running-the-project)
- [Folder Structure](#folder-structure)
- [Contributing](#contributing)
- [License](#license)
## Features
- Display incidents on an interactive map.
- Filter incidents by state, month, and year.
- Responsive design using TailwindCSS.
- Full-stack implementation using Next.js and Prisma with MongoDB.
## Tech Stack
- **Next.js**: React framework for server-rendered applications.
- **TypeScript**: Typed JavaScript for better code quality and developer experience.
- **Prisma**: ORM (Object-Relational Mapping) for connecting to MongoDB.
- **MongoDB**: NoSQL database for storing incident data.
- **TailwindCSS**: Utility-first CSS framework for styling.
- **Vercel**: For Deployment.
## Setup Instructions
### Prerequisites
Before you begin, ensure you have the following installed:
- **Node.js**: Version 14 or higher.
- **npm** or **yarn**: Latest version.
- **MongoDB**: A running instance of MongoDB.
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/your-username/incident-map.git
cd incident-map
```
2. **Install dependencies:**
Using npm:
```bash
npm install
```
Using yarn:
```bash
yarn install
```
3. **Set up the database:**
Use Prisma to set up the MongoDB database.
```bash
npx prisma migrate dev --name init
```
This command applies any migrations and sets up your MongoDB schema.
## Environment Variables
Create a `.env` file in the root directory and add the following environment variables:
```plaintext
DATABASE_URL="mongodb+srv://:@cluster0.mongodb.net/?retryWrites=true&w=majority"
```
- `DATABASE_URL`: Your MongoDB connection string.
## Running the Project
To run the project locally, use the following command:
```bash
npm run dev
```
Or, if you're using yarn:
```bash
yarn dev
```
This command starts the Next.js development server on `http://localhost:3000`.
## Contributing
Contributions are welcome! Please fork this repository, create a new branch, and submit a pull request.
### Steps to Contribute
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes.
4. Commit your changes:
```bash
git commit -m "Add feature: your feature name"
```
5. Push to the branch:
```bash
git push origin feature/your-feature-name
```
6. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.