Starkfarm Client is a web application built using Next.js, bootstrapped with create-next-app.
To run the project locally and start using Starkfarm Client, follow these steps:
- Fork the repository:
Note: If you already forked, first sync your dev to this repo's dev. This is to ensure, the commit history is exactly same. We often use squash and merge, so if u start with ur old history, unnecessary commits may creep in.
- Clone your repo and Navigate to the project directory:
git clone https://github.com/yourusername/starkfarm-client.gitcd starkfarm-client- Install dependencies:
npm install
# or
yarn install
# or
pnpm install- Start the development server:
npm run dev
# or
yarn dev
# or
pnpm dev- Make sure to lint and format your code before creating a PR
npm run lint:checkto check for lint errorsnpm run lint:fixto fix lint errorsnpm run format:checkto format the codenpm run format:fixto 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.
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.