diff --git a/README.md b/README.md index c403366..125c84c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,46 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Starknet RPC Request Builder + +The Starknet RPC Request Builder is an innovative tool tailored for developers and users looking to interact with the Starknet ecosystem. Powered by Nethermind's robust free RPC Service, this tool simplifies the process of creating, modifying, and testing JSON-RPC requests. + +Starknet is a layer-2 scaling solution for Ethereum. It offers scalability, privacy, and lower transaction costs. The Starknet RPC Request Builder simplifies the process of interacting with Starknet by providing a user friendly web interface for creating, modifying, and testing JSON-RPC requests. + +## Features + +- **JSON-RPC Request Management:** Create, edit, and test JSON-RPC requests +- **Starknet Ecosystem Integration:** Interact with the Starknet ecosystem +- **Free RPC Service from Nethermind:** Reliable RPC Service from the Nethermind team. +- **Font Optimization:** Automatically loads and optimizes fonts using {next/font}. +- **Customization:** Easily develop and modify functionality to meet unique needs. ## Getting Started -First, run the development server: +### Installation + +1. Clone the Repository: + + ```bash + git clone https://github.com/NethermindEth/rpc-request-builder.git + ``` + +2. Navigate to the Project Directory: + + ```bash + cd rpc-request-builder + ``` + +3. Install Dependencies: + + ```bash + npm install + # or + yarn install + # or + pnpm install + ``` + +### Running the Application + +To run the development server, execute the following command: ```bash npm run dev @@ -10,27 +48,17 @@ npm run dev yarn dev # or pnpm dev -# or -bun dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +The application will be accessible at http://localhost:3000. -## Learn More +## Deployment -To learn more about Next.js, take a look at the following resources: +The simplest way to deploy Starknet RPC Request Builder application is by utilizing the Vercel Platform, created by the makers of Next.js. Refer to the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for detailed instructions on deploying your application on Vercel. -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +## Contributing +👋 Want to contribute to NethermindEth/rpc-request-builder? +If you have a bug or an idea, browse the open issues before opening a new one. +If you're ready to tackle some open issues, we've collected some good first issues for you. +[Refer here.](https://github.com/NethermindEth/rpc-request-builder/contribute) +```