Logo

new Design system for IES from scratch Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents About The Project Product Name Screen Shot

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

Your time should be focused on creating something amazing. A project that solves a problem and helps others You shouldn't be doing the same tasks over and over like creating a README from scratch You should implement DRY principles to the rest of your life 😄 Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the BLANK_README.md to get started.

(back to top)

Built With This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

React typescript

Getting Started This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites This is an example of how to list things you need to use the software and how to install them.

2. pnpm run dev Installation Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Clone the repo:

1. git clone https://github.com/mayargp/ies-ds.git

Install NPM packages: 2) pnpm install

Run the project 3) pnpm run dev

To apply any change to the main branch use this command: 4) git push -u origin main

Usage Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap Add Changelog Add back to top links Add Additional Templates w/ Examples Add "components" document to easily copy & paste sections of the readme Multi-language Support Chinese Spanish See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request (back to top)

License Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

Choose an Open Source License GitHub Emoji Cheat Sheet Malven's Flexbox Cheatsheet Malven's Grid Cheatsheet Img Shields GitHub Pages Font Awesome React Icons