Penny is a web-based letter writing app that allows users to create heartfelt letters and easily share them with loved ones. This project provides a simple and intuitive platform for users to express themselves through written messages.
-
User-Friendly Interface: Penny offers a clean and user-friendly interface, making it easy for users to navigate and write letters.
-
Markdown Support: The app supports Markdown, allowing users to format their text, add images, and make their letters visually appealing.
-
Background Customization: Users can customize the background color of their letters to add a personal touch to their messages.
-
Privacy and Security: All letters are private by default, and only those with the unique link can view them. The app prioritizes user privacy and does not share personal information with third parties.
-
Write a Letter: Click on the "Write a Letter" button to start composing your message. Use the provided text area to pour your thoughts, emotions, and stories into your letter.
-
Background Customization: Optionally, customize the background color to give your letter a personal touch.
-
Publish Letter: Hit the "Publish Letter" button to share your creation with the world.
-
Markdown Support: Feel free to use Markdown to format your text. A Markdown cheat sheet is provided for reference.
-
Sharing Your Letters: After publishing your letter, you'll receive a unique link. Share this link with friends, family, or anyone you want to send your letter to.
To get started with Penny on your local machine, follow these steps:
-
Clone the repository:
git clone https://github.com/oyejateen/penny.git
-
Install dependencies:
npm install
-
Start the development server:
npm start
-
Open your browser and go to http://localhost:3000 to access Penny.
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js, Express
- Database: MongoDB (Optional, for future expansion)
- External Libraries: Font Awesome (for icons)
If you'd like to contribute to Penny, please follow these steps:
- Fork the repository.
- Create a new branch for your feature:
git checkout -b feature-name
. - Commit your changes:
git commit -m 'Add new feature'
. - Push to your branch:
git push origin feature-name
. - Submit a pull request.
If you encounter any issues or have suggestions for improvement, please open an issue. Your feedback is highly appreciated.
This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for your own projects.