Skip to content

Zac-Zajdel/bookmark-oasis

Repository files navigation

Bookmark Oasis

🎉 Features

  • 🚀 Next.js 15 (App router) - Meta Framework for React
  • ⚛️ React 19 - A library for web and native user interfaces
  • 📘 Typescript - JavaScript with syntax for types
  • 🎨 TailwindCSS V4 - Class sorting, merging and linting
  • 🛠️ shadcn/ui - Customizable UI components
  • 🔒 Auth.js - Authentication library (Google provider)
  • 🛡️ Prisma - Next-generation Node.js and TypeScript ORM
  • 🔍 Zod - Schema validation library
  • 🧪 Vitest - Vite powered API and component test framework
  • 💅 Prettier - Code formatter
  • 🧹 Eslint - Code linting tool
  • 🔹 Lucide - Icons
  • 🌑 Next-Themes - Dark Mode
  • ⚙️ T3 Env - Manage your environment variables
  • 🪵 Winston - Better development logging

🎯 Getting started

1. Clone this template

git clone https://github.com/Zac-Zajdel/bookmark-oasis.git

2. Install dependencies

yarn install

3. Set up environment variables

Create .env file and set env variables from .env.example file.

4. Run the dev server

Start the server using this command:

yarn dev

and open http://localhost:3000/ to see the landing page.

📁 Project structure

.
├── .github                         # GitHub folder
├── .next                           # Auto-generated build files from Next.js
├── app                             # Next JS App (App Router)
├── components                      # React components
├── hooks                           # Custom hooks
├── lib                             # Validation, functions, and utilities
├── prisma                          # Prisma schema and migrations
├── public                          # Public assets folder
├── scripts                         # Various node scripts
├── styles                          # Styles folder
├── tests                           # Vitest API calls
├── types                           # Type definitions
├── app.log                         # Winston Log file
├── logger.ts                       # Winston Log Generation config
├── auth.ts                         # Auth.js configuration
├── components.json                 # shadcn/ui configuration
├── env.ts                          # T3-env build time ENV check
├── middleware.ts                   # Middleware for Next.js routes

💡 Analyzing Bundle Size

ANALYZE=true yarn build

🤝 Contribution

To contribute, please follow these steps:

  1. Clone the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Push your changes to a PR.
  5. Create a pull request.

❤️ Support

If you like this project, feel free to leave a star. 🌟😊

Made by Zac Zajdel

About

Bookmark Management Tool

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors