CONTRIBUTING.md

Starkfarm Client

Starkfarm Client is a web application built using Next.js, bootstrapped with create-next-app.

Table of Contents

• Starkfarm Client
  • Table of Contents
  • Getting Started
  • Contributing
  • All Thanks To Our Contributors

Getting Started

To run the project locally and start using Starkfarm Client, follow these steps:

1. Clone the repository:

git clone https://github.com/yourusername/starkfarm-client.git

2. Navigate to the project directory:

cd starkfarm-client

3. Install dependencies:

npm install
# or
yarn install
# or
pnpm install

4. Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

5. Make sure to lint and format your code before creating a PR

• npm run lint:check to check for lint errors
• npm run lint:fix to fix lint errors
• npm run format:check to format the code
• npm run format:fix to fix the formatting
• If the code is not formatted properly, the CI will fail

Open http://localhost:3000 in your browser to see the Starkfarm Client in action.

For more details on API routes, check out the API documentation and edit the routes in src/app/api.

Contributing

We welcome contributions from the community to enhance Starkfarm Client further. If you're interested in contributing, please read our Contributing Guidelines for detailed information on how to get started.

All Thanks To Our Contributors