Muhammed-Rahif / Notepad

Notepad

Windows notepad in web with additional features!

📝 Table of Contents

• 🧐 About
  • Why I created ?
  • Helpful for ?
  • Who can contribute ?
• 🏁 Getting Started
  • Prerequisites
  • Installation
• 🔧 Running the tests
  • Tests commands
  • And coding style tests
• 🚀 Contributing
• ⛏️ Built Using
• ✍️ Author
• Contributors ✨

🧐 About

Why I created ?

I love open source and its maintaining so much. I wanted a minimal and simple project to attract newcomers and everyone in general to contribute to my next project.

That's when I think of windows notepad text editor. Earlier I used Windows, but now I am using Ubuntu, and Ubuntu doesn't have a notepad (have a text editor). So I decided to create a notepad (that looks like the windows notepad) that is accessible for every platform. However, the main goal was open-sourcing.

Helpful for ?

• Newcomers to open source
• Developers who are new to react and typescript
• For everyone who loves to use Windows notepad

Who can contribute ?

• Who is learning react and typescript or who already knows them both.
• Who have minimal and simple ideas relating to this project.
• Others who have interest

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Requirements you need to run the software and how to get them.

1. Git
2. NodeJs
3. Yarn package manager

Installation

A step by step series of examples that tell you how to get a development env running.

Firstly install the required packages

yarn install

And start the dev server by executing

yarn start

You will navigate to browser in url http://localhost:3000 (by default) to see the output.

🔧 Running the tests

How to run the automated tests for this software.

Tests commands

The following command will run tests each time you changes the code.

yarn test:watch

To get coverage report with tests

yarn test:coverage

To run tests with watching and coverage report

yarn test:watch:coverage

Run test cases using jest with jest-junit report (using in workflow run)

yarn test

And coding style tests

Check if any files need to be formatted, if the check fails that means some files needed to be formatted.

yarn check-format

To format all required code files

yarn format-code

🚀 Contributing

Read contributing instructions and guidlines from here.

⛏️ Built Using

• ReactJs - A JavaScript library for building user interfaces

✍️ Author

• @Muhammed-Rahif - Idea & Creator

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Muhammed Rahif 🐛 💻 📖 🖋 🎨 🤔 🚧 ⚠️ 👀 🚇	Aswin_Pradeep 💻 ⚠️	Anand Simmy 💻 👀	Khushboo Agarwal 💻 🤔 👀	Alen Abraham 📖	Muhammed radin 📖	Abhishek Pal 💻	Rishi Kumar Ray 💻
Divya Kelaskar 📖	Jaseem v 🐛

This project follows the all-contributors specification. Contributions of any kind are welcome!