Skip to content

Commit

Permalink
refactor: Minor Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
drealdumore committed Nov 23, 2024
1 parent c9372b6 commit 6e30217
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 27 deletions.
80 changes: 54 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,55 @@
# Q

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.1.1.

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
# Write it

Turn your digital text into beautiful, realistic handwritten notes effortlessly! 🚀
This app is designed to let you create personalized notes, letters, and reminders with customizable handwriting styles and colors.

## Features
- **Realistic Handwriting:** Converts your text into authentic-looking handwriting.
- **Customization Options:** Choose from different handwriting styles and colors.
- **Simple and Intuitive:** User-friendly design for seamless experience.
- **Versatile Use:** Perfect for creating personal notes, letters, or unique reminders.

## Tech Stack
- **Angular**: For a fast and responsive front-end experience.
- **TypeScript**: Ensuring type safety and better code maintainability.
- **Tailwind CSS**: For sleek and modern styling.
- **SaaS Architecture**: Bringing digital-to-handwriting transformation as a service.

## How It Works
1. Input your text in the app.
2. Select your preferred handwriting style, size and color.
3. Download your handwritten creation!

## Installation
1. Clone the repository:
```bash
git clone https://github.com/drealdumore/write-it.git
```
2. Navigate to the project directory:
```bash
cd write-it
```
3. Install dependencies:
```bash
npm install
```
4. Start the development server:
```bash
npm run start
```

## Roadmap
- Add more handwriting styles.
- Canvas sizing fix.
- Improve conversion.
- Enable exporting as PDF or image files.
- Integrate with cloud storage for saving creations.
- Support for multiple languages.

## Contributing
Contributions are welcome! Feel free to fork the repository and submit a pull request.

---

### Let’s bring back the charm of handwriting✨
3 changes: 3 additions & 0 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,8 @@
}
}
}
},
"cli": {
"analytics": false
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "q",
"name": "write-it",
"version": "0.0.0",
"scripts": {
"ng": "ng",
Expand Down

0 comments on commit 6e30217

Please sign in to comment.