Skip to content

A maintained simple starter dev environment on Plutus with dev container

License

Notifications You must be signed in to change notification settings

sidan-lab/plutus-dev-container

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SIDAN Lab Logo

Plutus Development Template

A template for Plutus smart contract development with everything you need to get started quickly. This template streamlines your development process and provides a structured foundation for your smart contracts. With the dev container setup, you could get the pre-compiled linting support and import suggestion to streamline PlutusTx development.

Features

  • Ready-to-Use: Start Plutus smart contract development instantly with all required dependencies pre-configured.

  • Best Practices: Follows best practices for Plutus development to ensure high-quality code.

  • Project Structure: Well-organized project structure for easy navigation and scalability.

  • Tested: Includes sample Plutus contracts and tests for reference.

Getting Started

Follow these steps to get started with Plutus development using this template:

  1. Clone the Repository:

    git clone https://github.com/yourusername/plutus-development-template.git
    cd plutus-development-template
  2. Entering Dev Container:

  3. Start Developing:

You're ready to start developing your Plutus smart contracts! Use the provided structure as a foundation for your projects.

  1. Testing:

    Run tests to ensure your contracts work as expected:

    cabal test
  2. Documentation:

    Ensure to update this README with specific information about your project.

Only Using the Dev Container

Simply putting the .devcontainer into the root level of your building source code of PlutusTx would work!

Directory Structure

  • src/: Your Plutus smart contract source files.
  • test/: Test scripts for your smart contracts.
  • scripts/: Useful scripts for deployment, testing, and more.
  • example/: Example Plutus contracts for reference.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Acknowledgments

  • 4th Cohort of Plutus Pioneer Programme, where the dev container template is built on top of there.

Author

Support

For support or inquiries, please contact @SIDANWhatever.

Disclaimer

This template is provided as a starting point for Plutus smart contract development. Please ensure that you understand the Cardano and Plutus development ecosystem and best practices before deploying smart contracts to a live network.

About

A maintained simple starter dev environment on Plutus with dev container

Resources

License

Stars

Watchers

Forks