Skip to content

Commit b4f7e76

Browse files
initial
1 parent 6d168a5 commit b4f7e76

File tree

10 files changed

+1062
-124
lines changed

10 files changed

+1062
-124
lines changed

CODE_OF_CONDUCT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# 🌈 Code of Conduct for Textify
2+
3+
I am committed to providing a welcoming and inclusive environment for everyone involved with **Textify**. This code of conduct outlines my expectations for participants and the consequences for unacceptable behavior.
4+
5+
## 👥 My Standards
6+
7+
I expect all participants to:
8+
9+
- **Be Respectful**: Treat everyone with kindness and consideration. Be respectful of differing opinions and experiences.
10+
- **Be Inclusive**: Strive to create an inclusive environment. Avoid language that excludes or discriminates against any group.
11+
- **Communicate Constructively**: Provide constructive feedback and make suggestions in a respectful manner. Aim to uplift and support others.
12+
- **Be Responsible**: Take responsibility for your actions and their impact on others. Apologize if you have caused harm and learn from the experience.
13+
14+
## 🚫 Unacceptable Behavior
15+
16+
Examples of unacceptable behavior include, but are not limited to:
17+
18+
- Harassment, intimidation, or bullying.
19+
- Publishing or distributing discriminatory remarks, including those based on race, ethnicity, nationality, religion, gender, sexual orientation, disability, or any other personal characteristic.
20+
- Engaging in sexual attention or advances.
21+
- Disruptive behavior that interferes with the participation of others.
22+
- Falsely reporting someone for a violation of this code of conduct.
23+
24+
## ⚖️ Consequences of Unacceptable Behavior
25+
26+
I reserve the right to warn, ban, or expel participants from **Textify** if they violate this code of conduct. Contributions that do not align with these standards may also be removed.
27+
28+
## 📝 Reporting Issues
29+
30+
If you experience or witness unacceptable behavior, please report it to me immediately. You can reach me at [[email protected]]. All reports will be handled with discretion and respect for privacy.
31+
32+
## 💡 Acknowledgments
33+
34+
This code of conduct is based on the [Contributor Covenant](https://www.contributor-covenant.org/) version 2.1, which is an open-source community standards document.
35+
36+
Thank you for helping to make **Textify** a welcoming and inclusive project for everyone!

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 🤝 Contributing to Textify
2+
3+
Thank you for considering contributing to **Textify**! Your help is greatly appreciated and essential for making this project better. Whether you're reporting bugs, suggesting features, or contributing code, your input is valuable.
4+
5+
## ✨ How to Contribute
6+
7+
Here are a few ways you can contribute:
8+
9+
### 1. Reporting Issues
10+
11+
If you encounter a bug or have a feature request, please open an issue on the [GitHub Issues page](https://github.com/yourusername/Textify/issues). When reporting issues, please include:
12+
13+
- A clear description of the problem or feature.
14+
- Steps to reproduce the issue (if applicable).
15+
- Any relevant screenshots or logs.
16+
17+
### 2. Suggesting Features
18+
19+
If you have an idea for a new feature, feel free to share it! Open an issue with a description of the feature and how it can benefit **Textify**.
20+
21+
### 3. Contributing Code
22+
23+
If you'd like to contribute code, please follow these steps:
24+
25+
1. **Fork the Repository**: Click the "Fork" button in the upper right corner of the repository page.
26+
2. **Clone Your Fork**: Clone your forked repository to your local machine:
27+
```bash
28+
git clone https://github.com/yourusername/Textify.git
29+
cd Textify
30+
```
31+
3. **Create a Branch**: Create a new branch for your feature or bug fix:
32+
```bash
33+
git checkout -b your-feature-branch
34+
```
35+
4. **Make Your Changes**: Make the necessary changes in your local repository.
36+
5. **Commit Your Changes**: Commit your changes with a descriptive message:
37+
```bash
38+
git commit -m "Add a new feature or fix a bug"
39+
```
40+
6. **Push Your Changes**: Push your changes to your forked repository:
41+
```bash
42+
git push origin your-feature-branch
43+
```
44+
7. **Open a Pull Request**: Go to the original repository and click on "Pull Requests." Then click "New Pull Request" to open a pull request.
45+
46+
### 4. Reviewing Pull Requests
47+
48+
If you're interested in reviewing contributions, please check the open pull requests and provide feedback. Your insights can help improve the quality of the project!
49+
50+
## 📝 Guidelines for Contributions
51+
52+
- **Follow the Code Style**: Make sure your code adheres to the existing code style of the project.
53+
- **Write Clear Commit Messages**: Write concise and clear commit messages that explain your changes.
54+
- **Test Your Changes**: Ensure that your changes work as expected and do not introduce new issues.
55+
56+
## 🎉 Thank You!
57+
58+
Your contributions make **Textify** a better tool for everyone. Thank you for your support and for being a part of this project!
59+
60+
If you have any questions, feel free to reach out to me at [[email protected]].

README.md

Lines changed: 68 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,99 @@
1-
# Getting Started with Create React App
1+
# 🖊️ Textify
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
<p align="center">
4+
<img src="https://raw.githubusercontent.com/CyberSaikat/testify/main/public/images/banner.png" alt="Leading Image" width="100%">
5+
</p>
46

5-
## Available Scripts
7+
**Textify** is a powerful React application that transforms your ideas into visually striking text compositions. With an intuitive interface and a rich set of features, Textify empowers you to create, edit, and manipulate text elements on a dynamic canvas. Whether you're designing social media posts, creating memes, or prototyping layouts, Textify is your go-to tool for text-based creativity.
68

7-
In the project directory, you can run:
9+
[![GitHub license](https://img.shields.io/github/license/CyberSaikat/textify.svg)](https://github.com/CyberSaikat/textify/blob/master/LICENSE)
10+
[![GitHub stars](https://img.shields.io/github/stars/CyberSaikat/textify.svg)](https://github.com/CyberSaikat/textify/stargazers)
11+
[![GitHub issues](https://img.shields.io/github/issues/CyberSaikat/textify.svg)](https://github.com/CyberSaikat/textify/issues)
812

9-
### `npm start`
13+
## 🌟 Key Features
1014

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
15+
- **📝 Dynamic Text Creation**: Add multiple text elements to your canvas with a single click.
16+
- **🖱️ Intuitive Drag-and-Drop**: Effortlessly position your text anywhere on the canvas.
17+
- **🎨 Rich Styling Options**: Apply bold, italic, and underline styles. Customize font size and color to your heart's content.
18+
- **↩️ Undo/Redo Functionality**: Experiment freely with the ability to revert or reapply changes.
19+
- **🖼️ Export as Image**: Save your masterpiece as a high-quality image for easy sharing.
20+
- **📱 Responsive Design**: Create on any device with our mobile-friendly interface.
1321

14-
The page will reload when you make changes.\
15-
You may also see any lint errors in the console.
22+
## 🚀 Getting Started
1623

17-
### `npm test`
24+
### Prerequisites
1825

19-
Launches the test runner in the interactive watch mode.\
20-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
26+
Ensure you have the following installed:
2127

22-
### `npm run build`
28+
- [Node.js](https://nodejs.org/) (version 14 or above)
29+
- [npm](https://www.npmjs.com/) (comes bundled with Node.js)
2330

24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
31+
### Quick Start
2632

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
33+
1. **Clone the repository**
34+
```bash
35+
git clone https://github.com/yourusername/textify.git
36+
cd textify
37+
```
2938

30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
39+
2. **Install dependencies**
40+
```bash
41+
npm install
42+
```
3143

32-
### `npm run eject`
44+
3. **Fire up the application**
45+
```bash
46+
npm start
47+
```
3348

34-
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
49+
4. Open your browser and navigate to `http://localhost:3000`. Start creating!
3550

36-
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
51+
## 🎨 How to Use Textify
3752

38-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
53+
1. **Add Text**: Click the "+" button to add a new text element to your canvas.
54+
2. **Style Your Text**: Use the toolbar to apply bold, italic, or underline styles. Adjust font size and color with the provided controls.
55+
3. **Position Text**: Click and drag text elements to position them precisely on the canvas.
56+
4. **Edit Text**: Double-click any text element to modify its content.
57+
5. **Undo/Redo**: Made a mistake? Use the undo and redo buttons to step backward or forward through your changes.
58+
6. **Export**: Happy with your creation? Click "Export Canvas" to download your design as an image.
3959

40-
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
60+
## 🛠️ Built With Cutting-Edge Tech
4161

42-
## Learn More
62+
- [React](https://reactjs.org/) - For building a dynamic and responsive UI
63+
- [Bootstrap](https://getbootstrap.com/) - For sleek, responsive styling
64+
- [html2canvas](https://html2canvas.hertzen.com/) - For high-quality canvas exports
65+
- [react-draggable](https://github.com/react-grid-layout/react-draggable) - For smooth drag-and-drop functionality
4366

44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
67+
## 🤝 Contributing to Textify
4568

46-
To learn React, check out the [React documentation](https://reactjs.org/).
69+
We welcome contributions from the community! Here's how you can help:
4770

48-
### Code Splitting
71+
1. **Fork** the repository
72+
2. **Create** your feature branch: `git checkout -b feature/AmazingFeature`
73+
3. **Commit** your changes: `git commit -m 'Add some AmazingFeature'`
74+
4. **Push** to the branch: `git push origin feature/AmazingFeature`
75+
5. **Open** a pull request
4976

50-
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
77+
Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
5178

52-
### Analyzing the Bundle Size
79+
## 📜 License
5380

54-
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
81+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
5582

56-
### Making a Progressive Web App
83+
## 🙌 Acknowledgments
5784

58-
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
85+
- Hat tip to anyone whose code was used
86+
- Inspiration
87+
- etc
5988

60-
### Advanced Configuration
89+
## 📞 Get in Touch
6190

62-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
91+
Have questions, feedback, or just want to say hi? We'd love to hear from you!
6392

64-
### Deployment
93+
- **Creator**: Saikat Roy
94+
- **Email**: [[email protected]](mailto:[email protected])
95+
- **GitHub**: [@CyberSaikat](https://github.com/CyberSaikat)
6596

66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
97+
---
6798

68-
### `npm run build` fails to minify
69-
70-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
99+
Made with ❤️ by Saikat Roy

0 commit comments

Comments
 (0)