https://github.com/danielcgilibert/openlink
🔗 Minimalist App for your links.
https://github.com/danielcgilibert/openlink
app-directory docker docker-compose headlessui linktree linktree-alternative linktree-clone next-auth nextjs13 react-hot-toast reactjs reactspring server-components tailwindcss tanstack-react-query typescript
Last synced: 8 months ago
JSON representation
🔗 Minimalist App for your links.
- Host: GitHub
- URL: https://github.com/danielcgilibert/openlink
- Owner: danielcgilibert
- License: mit
- Created: 2023-05-15T21:02:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-03T17:25:02.000Z (over 2 years ago)
- Last Synced: 2025-05-12T13:14:50.332Z (8 months ago)
- Topics: app-directory, docker, docker-compose, headlessui, linktree, linktree-alternative, linktree-clone, next-auth, nextjs13, react-hot-toast, reactjs, reactspring, server-components, tailwindcss, tanstack-react-query, typescript
- Language: TypeScript
- Homepage: https://openlinkapp.vercel.app
- Size: 3.17 MB
- Stars: 7
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚧 This project is under development 🚧
## ⚙️ Stack
- [**Next.js 13 /app directory** + **Typescript**](https://nextjs.org/) - The React Framework.
- [**Tailwind CSS** + **Tailwind-Merge** + **clsx**](https://tailwindcss.com/) - Tailwind CSS is a utility-first CSS framework.
- [**Headless UI**](https://headlessui.com/) - Completely unstyled, fully accessible UI components.
- [**Tabler Icons**](https://tabler-icons.io/i/) - A open source SVG icons.
- [**React Hot Toast**](https://react-hot-toast.com/) - Notifications library.
- [**Zustand**](https://zustand-demo.pmnd.rs/) - State management in React.
- [**Next Auth**](https://next-auth.js.org/) - Authentication for Next.js.
- [**Prisma**](https://www.prisma.io/) - ORM for Node.js & TypeScript.
- [**React Spring**](https://www.react-spring.dev/) - The animation lib React Spring.
- [**TanStack Query**](https://tanstack.com/query/latest) - TanStack Query powerful asynchronous state management.
- [**Docker**](https://www.docker.com/) - Development environment.
## 🛣️ Roadmap
- ❌ Improve loads
## 🧪 Demo
https://github.com/danielcgilibert/OpenLink/assets/44746462/50a78c1e-ff9f-4618-8129-c396286073df
## ✏️ Prerequisites
Make sure you have Docker and Docker Compose installed on your machine before proceeding.
- [Nodejs +16 (LTS recommended)](https://nodejs.org/en/)
- [Docker](https://www.docker.com/get-started)
- [Docker Compose](https://docs.docker.com/compose/install/)
## 📦 Environment Variables
Change the file .env.template to .env.development :
```env
# Database connection string:
DATABASE_URL=""
# Next-Auth config:
NEXTAUTH_SECRET="" # Generate a random string.
NEXTAUTH_URL="" # Your project url http://localhost:3000.
# Google OAuth Provider:
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""
```
## 🚀 Getting Started
**Recommended extensions for VSCode:**
- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss).
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode).
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
1. Clone or [fork](https://github.com/danielcgilibert/OpenLink/fork) the repository:
```bash
git@github.com:danielcgilibert/OpenLink.git
```
2. Install dependencies:
```bash
npm install
# or
yarn install
# or
pnpm install
```
3. Run the following command to start the database:
```bash
docker-compose up
```
4. Run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
## ☁ Deploys
- [Vercel](https://vercel.com/)
- [PlanetScale](https://planetscale.com/)
## 🔑 License
- [MIT](https://github.com/danielcgilibert/OpenLink/blob/main/LICENSE).