Open-source Bitcoin Script learning platform and development environment

View Live Demo • Features • Getting Started • Contributing • License

BitScript is an open-source educational platform and development environment designed to help Bitcoin enthusiasts, developers, and learners understand and experiment with Bitcoin Script. It provides interactive tools, tutorials, and a sandbox environment to explore the capabilities of Bitcoin's scripting language.

• Tutorials and Learning Modules: Comprehensive learning materials for Bitcoin Script and core Bitcoin concepts
• Interactive Script Sandbox: Test and experiment with Bitcoin Script in real-time
• RPC Explorer: Interface with Bitcoin commands through a friendly UI
• Transaction Deserialization: Deserialize Bitcoin transaction data in real-time
• Hash Calculator: Various tools for cryptographic hash operations
• Data Formatter: Format various data types
• Multisig Tools: Create and manage multisig addresses
• OP-CODE Visualizations: Visualize OP-CODES in action
• SCRIPT Visualizations: Visualize various Bitcoin standard scripts in action

• Node.js (v18 or later)
• Yarn package manager
• Git

1. Clone the repository:

   git clone https://github.com/Strata-Labs/BitScript.git
   cd BitScript

2. Install dependencies:

   yarn install

3. Set up environment variables:

   • Create a .env file in the root directory
   • Copy the contents of .env.example into .env
   • Update the variables as needed

4. Set up the database:

   npx prisma migrate dev

5. Start the development server:

   yarn run dev

The application should now be running at http://localhost:3000.

We welcome contributions from developers of all skill levels! Here's how you can contribute to BitScript:

Please read our Code of Conduct before contributing to the project.

1. Find an Issue: Browse the Issues section to find something to work on, or open a new issue if you've found a bug or have a feature request.

2. Fork the Repository: Create your own copy of the project to work on.

3. Create a Branch: Create a new branch for your changes:

   git checkout -b feature/your-feature-name

4. Make Changes: Implement your changes, following the coding standards and guidelines.

5. Commit: Commit your changes with a descriptive message:

   git commit -m "Add feature: your feature description"

6. Push Changes: Push your changes to your fork:

   git push origin feature/your-feature-name

7. Open a Pull Request: Create a pull request from your branch to the main repository.

• Follow the existing code style and naming conventions
• Write clear, descriptive commit messages
• Include comments for complex logic
• Update documentation for any new features or changes
• Test your code thoroughly before submitting a pull request

If you need help with contributing, feel free to:

• Ask questions in the Discussions section
• Reach out to the maintainers via email at [email protected] or Twitter

BitScript is open-source software licensed under the MIT License.

Made with ❤️ by Setdev Team