solidity-template

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

Table of Contents

1. 
   About The Project
   
   
   
   • Built With
   
   
   
   


2. 
   Getting Started
   
   
   
   • Prerequisites
   
   
   • Installation
   
   
   
   


3. Usage


4. License


5. Contact

About The Project

npm package

There are many great solidity templates available on GitHub; however, I didn't
find one that really suited my needs so I created this enhanced one.

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 and configuring project from scratch
* You should implement DRY principles to the rest of your life :smile:

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 template repos and creating a pull request or opening an
issue. Thanks to all the people have contributed to expanding this template!

1. Hardhat Template Repo
2. Truffle Template Repo

$3

* Node js
* npm

Getting Started

Please install the package globally so that you can get the template from
anywhere

To get a local copy up and running follow these simple example steps.

``sh
git clone https://github.com/akshay-na/solidity-template
cd solidity-template
npm install
`

$3

Make sure that the following prerequisites is installed before using the package

* Node Js
* npm

`sh
npm install npm@latest -g
`

$3

1. Install the package globally

`sh
npm i -g solidity-template
`

Usage

Once the package is installed, globally, go to the directory from where you want
to start the project and run the following command

`sh
npx solidity-template
`

When you run the above command, you will be prompted to select the template.
Select your option and the package will clone and install dependencies of that
particular template.

License

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

Contact

Your Name - Akshay N

Project Link: https://github.com/akshay-na/solidity-template



[contributors-shield]: https://img.shields.io/github/contributors/akshay-na/solidity-template.svg?style=for-the-badge
[contributors-url]: https://github.com/akshay-na/solidity-template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/akshay-na/solidity-template.svg?style=for-the-badge
[forks-url]: https://github.com/akshay-na/solidity-template/network/members
[stars-shield]: https://img.shields.io/github/stars/akshay-na/solidity-template.svg?style=for-the-badge
[stars-url]: https://github.com/akshay-na/solidity-template/stargazers
[issues-shield]: https://img.shields.io/github/issues/akshay-na/solidity-template.svg?style=for-the-badge
[issues-url]: https://github.com/akshay-na/solidity-template/issues
[license-shield]: https://img.shields.io/github/license/akshay-na/solidity-template.svg?style=for-the-badge
[license-url]: https://github.com/akshay-na/solidity-template/blob/master/LICENSE.txt