Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamed-lifa7/simple-email-client
A lightweight email client built with Next.js and Vercel Postgres.
https://github.com/mohamed-lifa7/simple-email-client
email-client nextjs14 postgresql server-actions shadcn-ui vercel vercel-postgres
Last synced: 13 days ago
JSON representation
A lightweight email client built with Next.js and Vercel Postgres.
- Host: GitHub
- URL: https://github.com/mohamed-lifa7/simple-email-client
- Owner: mohamed-lifa7
- License: mit
- Created: 2023-11-11T21:31:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-11T21:34:43.000Z (about 1 year ago)
- Last Synced: 2024-04-14T03:01:07.215Z (7 months ago)
- Topics: email-client, nextjs14, postgresql, server-actions, shadcn-ui, vercel, vercel-postgres
- Language: TypeScript
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Email Client
A lightweight email client built with Next.js and Vercel Postgres.
## Features
**Column Layout Navigation**: Navigate seamlessly between routes using a column layout for an intuitive user experience.
**Progressive Enhancement**: Enhance user experience progressively by leveraging modern web technologies.
**Prefetching and Caching**: Optimize performance with prefetching and caching strategies.
**Server Actions: Implement**: server actions reminiscent of traditional PHP-based applications.
## Tech
- [Next.js](https://nextjs.org/)
- [Vercel Postgres](https://vercel.com/docs/storage/vercel-postgres)
- [Tailwind CSS](https://tailwindcss.com/)
- [Shadcn UI](https://ui.shadcn.com)
- [TypeScript](https://www.typescriptlang.org/)
## To-Do (Fixes)
- [ ] **Forward and Reply Functionality**: Implement forwarding and replying to emails for enhanced communication.
- [ ] **Enhanced Sender/Recipient Handling**: Refine sender/recipient information handling to pull data seamlessly anywhere in the application.
- [ ] Need to add a way to manage users
- [ ] Error handling for form submissions
- [ ] Make it reponsive
- [x] Need to add a way to manage folders
- [x] Add search
## Setup
In order to run this project locally, you'll need to create a Postgres database and add the connection string to your `.env.local` file.
Further, you'll need to create the tables and insert some sample data.
Follow these steps to get started:
1. Create a Postgres database
2. Navigate to the `.env.local` tab in the quickstart section Postgres dashboard
3. Copy the snippet and paste it into your `.env.local` file
4. Run `pnpm run setup` to create the tables and insert sample data
## Schema
```
CREATE TABLE users (
id SERIAL PRIMARY KEY,
first_name VARCHAR(50),
last_name VARCHAR(50),
email VARCHAR(255) UNIQUE NOT NULL
);
CREATE TABLE emails (
id SERIAL PRIMARY KEY,
sender_id INTEGER REFERENCES users(id),
recipient_id INTEGER REFERENCES users(id),
subject VARCHAR(255),
body TEXT,
sent_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE folders (
id SERIAL PRIMARY KEY,
name VARCHAR(50) NOT NULL
);
CREATE TABLE user_folders (
id SERIAL PRIMARY KEY,
user_id INTEGER REFERENCES users(id),
folder_id INTEGER REFERENCES folders(id)
);
CREATE TABLE email_folders (
id SERIAL PRIMARY KEY,
email_id INTEGER REFERENCES emails(id),
folder_id INTEGER REFERENCES folders(id)
);
```
## Sample Data
```
INSERT INTO users (first_name, last_name, email)
VALUES ('John', 'Doe', '[email protected]'),
('Jane', 'Doe', '[email protected]'),
('Alice', 'Smith', '[email protected]'),
('Bob', 'Johnson', '[email protected]');
INSERT INTO emails (sender_id, recipient_id, subject, body, sent_date)
VALUES (1, 2, 'Meeting Reminder', 'Don''t forget about our meeting tomorrow at 10am.', '2022-01-10 09:00:00'),
(1, 3, 'Hello', 'Just wanted to say hello.', '2022-01-09 08:00:00'),
(2, 1, 'Re: Meeting Reminder', 'I won''t be able to make it.', '2022-01-10 10:00:00'),
(3, 1, 'Re: Hello', 'Hello to you too!', '2022-01-09 09:00:00'),
(4, 1, 'Invitation', 'You are invited to my party.', '2022-01-11 07:00:00'),
(1, 2, 'Work Project', 'Let''s discuss the new work project.', '2022-01-12 07:00:00'),
(1, 4, 'Expenses Report', 'Please find the expenses report attached.', '2022-01-13 07:00:00'),
(4, 1, 'Personal Note', 'Let''s catch up sometime.', '2022-01-14 07:00:00');
INSERT INTO folders (name)
VALUES ('Inbox'),
('Flagged'),
('Sent'),
('Work'),
('Expenses'),
('Personal');
INSERT INTO user_folders (user_id, folder_id)
VALUES (1, 1), (1, 2), (1, 3), (1, 4), (1, 5), (1, 6),
(2, 1), (2, 2), (2, 3), (2, 4), (2, 5), (2, 6),
(3, 1), (3, 2), (3, 3), (3, 4), (3, 5), (3, 6),
(4, 1), (4, 2), (4, 3), (4, 4), (4, 5), (4, 6);
INSERT INTO email_folders (email_id, folder_id)
VALUES (1, 1),
(2, 1),
(3, 3),
(4, 1),
(5, 1),
(6, 4),
(7, 5),
(8, 6);
```
## Database Relationships
- Users can send and receive emails (users.id -> emails.sender_id and emails.recipient_id)
- Users can have multiple folders (users.id -> user_folders.user_id)
- Folders can contain multiple emails (folders.id -> email_folders.folder_id)
- An email can be in multiple folders (emails.id -> email_folders.email_id)
## License
By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](./LICENSE).