https://github.com/mariangle/penpal
Full-stack app built using Next.js, TypeScript, Prisma and TailwindCSS
https://github.com/mariangle/penpal
mongodb prisma tailwindcss typescript
Last synced: 3 months ago
JSON representation
Full-stack app built using Next.js, TypeScript, Prisma and TailwindCSS
- Host: GitHub
- URL: https://github.com/mariangle/penpal
- Owner: mariangle
- Created: 2023-05-23T22:23:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-28T12:49:38.000Z (almost 3 years ago)
- Last Synced: 2025-01-10T14:02:40.737Z (over 1 year ago)
- Topics: mongodb, prisma, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://penpal-next.vercel.app
- Size: 740 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A full stack application built with Next.js and TypeScript.
Introduction ·
Tech Stack ·
Usage ·
License ·
Acknowledgements
## Introduction
Penpal is a full stack application designed to simulate the traditional experience of writing physical letters. It achieves this by incorporating delays in delivery time based on the geographical distance between users. The purpose of Penpal is to serve as a foundation for building a larger full stack application using the new Next.js app router. This expansion aims to enhance the application's API routes and responses, providing a more advanced user experience.
Here are some key features:
- [Text editing](#text-editing)
- [Mailbox](#mailbox)
- [Reviewing System](#reviewing-system)
### Text Editing
You can easily use the text editor that enables easy text formatting, image uploading and editing capabilities. Once your letter is sent, you will receive an estimated delivery time which will be based on the distance between you and the recipient.
### Mailbox
Your letters are organized into different categories: Inbox, Sent Letters, and Pending Letters. The categorization depends on the status of each letter.
### Reviewing System
Reviews will appear on a user's profile.
### Other features
When registering you are automatically assigned your country.
You can edit your profile and use the dark theme in the user navigation menu.
## Tech stack
- [Next.js](https://nextjs.org/) - framework
- [TypeScript](https://www.typescriptlang.org/) - language
- [Tailwind](https://tailwindcss.comm) - CSS
- [MongoDB](https://mongodb.com) - database
- [NextAuth.js](https://next-auth.js.org/) - auth
- [Vercel](https://vercel.com/) - hosting
## Usage
To access the app, you can log in using the provided test account. Please note that some actions may be restricted, but you'll still be able to send and receive letters.
**Test Account Credentials:**
Email: test@email.com
Password: test
## License
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Acknowledgements
- dub.sh
- shadcn
- date-fns