https://github.com/karan-develops/local-link
A hyper-local digital noticeboard for Indian neighborhoods. Post and view public events & notices relevant to your nearby area.
https://github.com/karan-develops/local-link
full-stack nextjs
Last synced: 10 months ago
JSON representation
A hyper-local digital noticeboard for Indian neighborhoods. Post and view public events & notices relevant to your nearby area.
- Host: GitHub
- URL: https://github.com/karan-develops/local-link
- Owner: Karan-develops
- License: mit
- Created: 2025-07-24T12:00:07.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-22T08:33:38.000Z (10 months ago)
- Last Synced: 2025-08-22T10:31:57.853Z (10 months ago)
- Topics: full-stack, nextjs
- Language: TypeScript
- Homepage: https://local-link-karan.vercel.app
- Size: 704 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Local Link - A hyper-local digital noticeboard
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#📚Tech-Stack)
- [Installation](#💻Installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Introduction
A hyper-local digital noticeboard for Indian neighborhoods. Post and view public events & notices relevant to your nearby area.
## 📚Tech-Stack
- **(Next Full Stack):**
- React.js
- Next.js
- Shadcn-ui
- TailwindCSS
- TypeScript
- Zod - Form Validation
- Framer-motion
- Firebase
- **Database:**
- Neon
- PostgreSQL
- Firebase
- Cloudinary
- **Version Control:**
- Git
```
## 📁 File Structure :
Directory structure:
└── next/
├── README.md
├── components.json
├── eslint.config.mjs
├── next.config.ts
├── package.json
├── postcss.config.mjs
├── tsconfig.json
├── actions/
│ ├── comments.actions.ts
│ ├── dashboard.actions.ts
│ ├── helper.actions.ts
│ ├── notices.actions.ts
│ ├── notifications.actions.ts
│ └── user.actions.ts
├── app/
│ ├── globals.css
│ ├── layout.tsx
│ ├── page.tsx
│ ├── api/
│ │ ├── comments/
│ │ │ └── route.ts
│ │ ├── create-user/
│ │ │ └── route.ts
│ │ ├── dashboard/
│ │ │ └── route.ts
│ │ ├── notices/
│ │ │ ├── route.ts
│ │ │ └── [id]/
│ │ │ ├── route.ts
│ │ │ └── upvote/
│ │ │ └── route.ts
│ │ ├── notifications/
│ │ │ └── route.ts
│ │ ├── post-notices/
│ │ │ └── route.ts
│ │ ├── set-session/
│ │ │ └── route.ts
│ │ └── upload-on-cloudinary/
│ │ └── route.ts
│ ├── auth/
│ │ └── page.tsx
│ ├── dashboard/
│ │ └── page.tsx
│ ├── map/
│ │ └── page.tsx
│ ├── notices/
│ │ ├── page.tsx
│ │ └── [id]/
│ │ └── page.tsx
│ ├── post/
│ │ └── page.tsx
│ └── user/
│ └── [id]/
│ └── page.tsx
├── components/
│ ├── AuthForm.tsx
│ ├── AuthProvider.tsx
│ ├── CardSkeleton.tsx
│ ├── CategoryFilterSection.tsx
│ ├── DashboardView.tsx
│ ├── Footer.tsx
│ ├── Hero.tsx
│ ├── LocationProvider.tsx
│ ├── MapView.tsx
│ ├── Navbar.tsx
│ ├── NoticeDetails.tsx
│ ├── NoticesView.tsx
│ ├── PostNoticeForm.tsx
│ ├── SessionWatcher.tsx
│ ├── ToggleTheme.tsx
│ ├── UserProfile.tsx
│ └── ui/
│ ├── avatar.tsx
│ ├── badge.tsx
│ ├── button.tsx
│ ├── card.tsx
│ ├── dropdown-menu.tsx
│ ├── input.tsx
│ ├── label.tsx
│ ├── popover.tsx
│ ├── scroll-area.tsx
│ ├── select.tsx
│ ├── separator.tsx
│ ├── sheet.tsx
│ ├── skeleton.tsx
│ ├── sonner.tsx
│ ├── switch.tsx
│ ├── tabs.tsx
│ └── textarea.tsx
├── hooks/
│ └── use-auth.ts
├── lib/
│ ├── cloudinary.ts
│ ├── prisma.ts
│ ├── utils.ts
│ ├── validations.ts
│ └── firebase/
│ ├── firebase-admin.ts
│ ├── firebase-auth.ts
│ ├── firebase.ts
│ └── upload-image.ts
├── prisma/
│ ├── schema.prisma
│ └── migrations/
│ ├── migration_lock.toml
│ ├── 20250726095710_init/
│ │ └── migration.sql
│ ├── 20250729115813_notices/
│ │ └── migration.sql
│ ├── 20250812095037_user_profile/
│ │ └── migration.sql
│ └── 20250812101829_user_profile/
│ └── migration.sql
├── types/
│ └── types.ts
└── utils/
├── distance.ts
├── refreshSessionCookie.ts
└── setSessionCookie.ts
```
### Environment Variables
| Variable | Description |
| :-------------------------------------------- | :------------------------------------------------------ |
| ----------------`DATABASE`------------------- | ------------------`DATABASE`-------------------------- |
| DATABASE_URL | Database URL from neon again make a free account |
| ----------------`FIREBASE`------------------- | ------------------`FIREBASE`-------------------------- |
| NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN | Create Firebase Project To Get this key |
| NEXT_PUBLIC_FIREBASE_PROJECT_ID | Create Firebase Project To Get this key |
| NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET | Create Firebase Project To Get this key |
| NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID | Create Firebase Project To Get this key |
| NEXT_PUBLIC_FIREBASE_APP_ID | Create Firebase Project To Get this key |
| NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID | Create Firebase Project To Get this key |
| ----------------`LOCATION`------------------- | ------------------`LOCATION`--------------------------- |
| NEXT_PUBLIC_NOMINATIM_URL | Contact me to get this URL |
| -------------`FIREBASE-ADMIN`---------------- | ------------------`FIREBASE-ADMIN`--------------------- |
| FIREBASE_PROJECT_ID | Download Create Admin Private Keys json file |
| FIREBASE_CLIENT_EMAIL | Download Create Admin Private Keys json file |
| FIREBASE_PRIVATE_KEY | Download Create Admin Private Keys json file |
# 💻Installation
## 🔥 Next-JS
To run this project locally, follow these steps:
1. Clone the repository:
`git clone https://github.com/Karan-develops/Local-Link`
2. Navigate to the project directory:
`cd next`
3. Install the dependencies:
`npm install`
4. Set up environment variables: - Create a `.env` file in the `next` directory, - Add the Variables given in above `next` Table.
5. Start the development server:
`npm run dev`
## Usage
- Open your browser and navigate to `http://localhost:3000` for next.
- Register a new account or log in with existing credentials.
- Explore the features and functionalities of the Local Link Project.
## Contributing
Contributions are welcome! Please follow these steps to contribute:
- Clone or fork this repo
> `Run` [ git clone ` https://github.com/Karan-develops/Local-Link `]
1. Fork the repository.
2. Create a new branch:
`git checkout -b feature/your-feature-name`
3. Make your changes and commit them:
`git commit -m "Add your message"`
4. Push to the branch:
`git push origin feature/your-feature-name`
5. Open a pull request.
## 🔒 License
This repository is open source and under [MIT](https://choosealicense.com/licenses/mit/) License.
--- **_Lets Build & Grow, Have a Good Day_** **😊** ---