https://github.com/adii1203/bookmark
https://github.com/adii1203/bookmark
authjs neondb nextjs postgres reactjs tailwindcss tanstack-react-query typescript
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/adii1203/bookmark
- Owner: adii1203
- Created: 2024-05-11T17:35:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-29T07:49:36.000Z (about 2 years ago)
- Last Synced: 2024-05-29T14:55:31.538Z (about 2 years ago)
- Topics: authjs, neondb, nextjs, postgres, reactjs, tailwindcss, tanstack-react-query, typescript
- Language: TypeScript
- Homepage: https://savedev.vercel.app/
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
This is a URL Bookmarker web application built using Next.js, Tailwind CSS, and MongoDB. It allows users to save and organize their favorite URLs for quick access.
## Features
- User Authentication: Users can sign up, log in, and log out securely.
- URL Bookmarking: Users can add, edit, and delete bookmarks.
- Categories: Bookmarks can be organized into categories for easier management.
- Responsive Design: The application is optimized for various screen sizes and devices.
## Technologies Used
- Next.js: React framework for building server-side rendered (SSR) and statically generated web applications.
- Tailwind CSS: Utility-first CSS framework for styling.
- Postgres: Neon postgres serverless database.
### Installation
**Clone the repository:**
```bash
git clone https://github.com/adii1203/bookmark.git
```
**Navigate to the project directory:**
```bash
cd bookmarker
```
**Install dependencies:**
```bash
npm install
```
**Set up MongoDB:**
- Install MongoDB if not already installed.
- Create a MongoDB Atlas cluster or set up a local MongoDB database.
- Configure the MongoDB connection string in .env file:
```javascript
MONGODB_URI = your_mongodb_uri;
```
#### Run the development server:
```bash
npm run dev
```
Access the application at http://localhost:3000.
#### Usage
- Sign up or log in to your account.
- Add new bookmarks by providing the URL and selecting a category.
- Edit or delete existing bookmarks as needed.
Organize bookmarks into categories for better management.
- Log out when done.
## Todos
- [x] Deploy to vercel
- [x] Creat database schema (w/ zod)
- [x] Connect to database (mongodb)
- [x] Creat register user route
- [x] Send email verification otp
- [ ] Add basic ui with mock data (tailwind, shadcn)
- [ ] Add authentication
- [ ] Add user profile