https://github.com/javayhu/free-directory-boilerplate
The Open Source Directory Boilerplate
https://github.com/javayhu/free-directory-boilerplate
boilerplate directory directory-boilerplate sanity sanity-studio
Last synced: 2 months ago
JSON representation
The Open Source Directory Boilerplate
- Host: GitHub
- URL: https://github.com/javayhu/free-directory-boilerplate
- Owner: javayhu
- License: mit
- Created: 2024-12-22T12:13:52.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-10T16:49:57.000Z (9 months ago)
- Last Synced: 2025-01-10T17:40:55.903Z (9 months ago)
- Topics: boilerplate, directory, directory-boilerplate, sanity, sanity-studio
- Language: TypeScript
- Homepage: https://free.mkdirs.com
- Size: 8.59 MB
- Stars: 138
- Watchers: 2
- Forks: 41
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-hacking-lists - javayhu/free-directory-boilerplate - The Open Source Directory Boilerplate (TypeScript)
README
Open Source Directory Boilerplate
Introduction ·
Features ·
Tech Stack ·
How to use ·
Author ·
Compare with Mkdirs ·
Notice ·
License ·
Credits
## Introduction
| Component | Website | Repository |
| --------- | ------- | ---------- |
| **Frontend** | [free-directory-boilerplate.vercel.app](https://free-directory-boilerplate.vercel.app) | [free-directory-boilerplate](https://github.com/javayhu/free-directory-boilerplate) |
| Backend (Sanity) | [free-directory-sanity.vercel.app/studio](https://free-directory-sanity.vercel.app/studio) | [free-directory-sanity](https://github.com/javayhu/free-directory-sanity) |
## Features
- Listings (Tools, Products)
- Item Detail Page
- Categories & Tags
- Authentication (GitHub and Google)
- Submission (built-in)
- Sanity Studio (built-in CMS)
- Blog (hidden by default)
- Documentation (hidden by default)
- Analytics (Umami & Google Analytics)
- SEO (Sitemap, Open Graph)
- Modern UI (Shadcn UI)
- Responsive Design
- Multi-language (English & Chinese)
- Multi-theme (Light & Dark)
## Tech Stack
- Next.js 14
- NextAuth
- Database (PostgreSQL)
- Tailwind CSS
- Shadcn UI
- Lucide Icons
- Contentlayer
- Sanity
- Vercel
## How to use
1. Clone the repository
2. Run `pnpm install`
3. Configure the `.env` file
4. Run `pnpm dev`
## Author
This project is created by [Fox](https://x.com/indie_maker_fox), the founder of [Mkdirs](https://mkdirs.com) and [MkSaaS](https://mksaas.com).
[Mkdirs](https://mkdirs.com) is the best directory boilerplate for anyone who wants to launch a profitable directory website in minutes.
[MkSaaS](https://mksaas.com) is the best AI SaaS boilerplate, you can launch your next AI SaaS in a weekend with MkSaaS template.
If you are interested in indie hacking, please follow me on X: [@indie_maker_fox](https://x.com/indie_maker_fox) or BlueSky: [@mksaas.me](https://bsky.app/profile/mksaas.me)
### Compare with Mkdirs
[Mkdirs](https://mkdirs.com) - The best directory boilerplate.
| Feature | Free Directory Boilerplate | Mkdirs |
| ------- | -------------------------- | ------ |
| Repos | ✅ 2 | ✅ 1 |
| Price | ✅ Free and Open Source | ✅ Paid |
| Auth | ✅ GitHub or Google | ✅ GitHub or Google or Email |
| Listings | ✅ Categories | ✅ Categories, Tags & Filters |
| Database | ✅ Need PostgreSQL | ✅ NO NEED! JUST SANITY! |
| Newsletter | ❌ Not supported | ✅ Supported |
| Payment | ❌ Not supported | ✅ Supported |
| Search | ❌ Not supported | ✅ Supported |
| Pagination | ❌ Not supported | ✅ Supported |
| Email Notification | ❌ Not supported | ✅ Supported |
| Submission | ✅ Built-in (Free) | ✅ Built-in (Free & Paid) |
| Blog | ✅ Contentlayer | ✅ Sanity CMS |
| Analytics | ✅ Umami & Google Analytics | ✅ OpenPanel & Google Analytics |
| SEO | ✅ Sitemap & Open Graph | ✅ Sitemap & Open Graph |
| Multi-language | ✅ English & Chinese | ✅ English |
| Multi-theme | ✅ Light & Dark | ✅ Light & Dark |
## Notice
If you have any questions when using this project, please checkout the [docs of Mkidrs](https://docs.mkdirs.com) for more information, because they have almost the same tech stack.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Credits
This project was inspired by [@miickasmt](https://twitter.com/miickasmt)'s [next-saas-stripe-starter](https://github.com/mickasmt/next-saas-stripe-starter)
## ⭐ Star History
[](https://star-history.com/#javayhu/free-directory-boilerplate&Date)