Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotBraem committed Dec 17, 2024
1 parent abc5cab commit b5c7605
Show file tree
Hide file tree
Showing 33 changed files with 819 additions and 2,821 deletions.
131 changes: 131 additions & 0 deletions .github/ISSUE_TEMPLATE/BOUNTY.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
name: "Simple Bounty"
description: "Use this template to create a HEROES Simple Bounty via Github bot"
title: "Bounty: "
labels: ["bounty"]
assignees: heroes-bot-test
body:
- type: markdown
attributes:
value: |
Hi! Let's set up your bounty! Please don't change the template - @heroes-bot-test won't be able to help you.
- type: dropdown
id: type
attributes:
label: What talent are you looking for?
options:
- Marketing
- Development
- Design
- Other
- Content
- Research
- Audit

- type: textarea
id: description
attributes:
label: What you need to be done?

- type: dropdown
id: tags
attributes:
label: Tags
description: Add tags that match the topic of the work
multiple: true
options:
- API
- Blockchain
- Community
- CSS
- DAO
- dApp
- DeFi
- Design
- Documentation
- HTML
- Javascript
- NFT
- React
- Rust
- Smart contract
- Typescript
- UI/UX
- web3
- Translation
- Illustration
- Branding
- Copywriting
- Blogging
- Editing
- Video Creation
- Social Media
- Graphic Design
- Transcription
- Product Design
- Artificial Intelligence
- Quality Assurance
- Risk Assessment
- Security Audit
- Bug Bounty
- Code Review
- Blockchain Security
- Smart Contract Testing
- Penetration Testing
- Vulnerability Assessment
- BOS
- News
- Hackathon
- NEARCON2023
- NEARWEEK

- type: input
id: deadline
attributes:
label: Deadline
description: "Set a deadline for your bounty. Please enter the date in format: DD.MM.YYYY"
placeholder: "19.05.2027"

- type: dropdown
id: currencyType
attributes:
label: Currency
description: What is the currency you want to pay?
options:
- USDC.e
- USDT.e
- DAI
- wNEAR
- USDt
- XP
- marmaj
- NEKO
- JUMP
- USDC
- NEARVIDIA
default: 0
validations:
required: true

- type: input
id: currencyAmount
attributes:
label: Amount
description: How much it will be cost?

- type: markdown
attributes:
value: "## Advanced settings"

- type: checkboxes
id: kyc
attributes:
label: KYC
description: "Use HEROES' KYC Verification, only applicants who passed HEROES' KYC can apply and work on this bounty!"
options:
- label: Use KYC Verification

- type: markdown
attributes:
value: |
### This cannot be changed once the bounty is live!
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: How can we reproduce the bug?
description: If you can make the bug happen again, please share the steps involved. If possible please also include a screenshot or a screen recording to help us better understand and resolve the issue.
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Feature request
description: File a feature request
title: "[Feature]: "
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Have an idea for a feature or change?
- type: textarea
id: description
attributes:
label: What's the feature?
description: Describe the feature, who it would help, and link to any examples from other apps.
validations:
required: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Task
description: File a task
title: "[Task]: "
labels: ["enabler"]
assignees: []
body:
- type: textarea
id: overview
attributes:
label: Overview
description: Provide a brief overview of the task to be done and any relevant context.
validations:
required: true
- type: textarea
id: details
attributes:
label: Details
description: Describe the task in detail, including any specific requirements and examples from other applications if available.
validations:
required: false
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: Define the criteria that must be met for the task to be considered complete.
validations:
required: false
21 changes: 21 additions & 0 deletions .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: CI
on:
pull_request:
push:
branches:
- main

jobs:
prettier:
name: Prettier
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v1
with:
bun-version: latest
- name: Install dependencies
run: bun install
- name: Run prettier
run: bun run fmt:check
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"trailingComma": "all",
"tabWidth": 2,
"semi": true,
"singleQuote": false
}
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing Guide

Thank you for considering contributing to this project! Here are some guidelines to help you get started.

## Getting Started

To contribute to this project, follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Make your changes locally.
4. Test your changes to ensure they work as expected.
5. Commit your changes with descriptive commit messages. We like [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716).
6. Push your changes to your fork on GitHub.
7. Create a pull request to the main repository.

## Code Style

Please follow the existing code style and conventions used in the project.

## Testing

This repository uses playwright tests, which can be found in [/playwright-tests](./playwright-tests/). Ensure that your changes include appropriate tests and that existing tests pass.

## Submitting Issues

If you encounter any issues or have feature requests, please submit them through GitHub issues. Include as much detail as possible to help us understand and address the problem efficiently.

Thank you for your interest in contributing to this project! Your contributions are greatly appreciated.
93 changes: 53 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,63 @@
# React + TypeScript + Vite
<!-- markdownlint-disable MD014 -->
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD029 -->

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<div align="center">

Currently, two official plugins are available:
<h1 style="font-size: 2.5rem; font-weight: bold;">$HIJACK Website</h1>

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
<p>
<strong>Landing page for $HIJACK project</strong>
</p>

## Expanding the ESLint configuration
</div>

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
<details>
<summary>Table of Contents</summary>

- Configure the top-level `parserOptions` property like this:
- [Getting Started](#getting-started)
- [Installing dependencies](#installing-dependencies)
- [Running the app](#running-the-app)
- [Building for production](#building-for-production)
- [Contributing](#contributing)

```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
</details>

## Getting Started

### Installing dependencies

```bash
bun install
```

### Running the app

First, run the development server:

```bash
bun run dev
```

- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:

```js
// eslint.config.js
import react from 'eslint-plugin-react'

export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
### Building for production

```bash
bun run build
```

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you're interested in contributing to this project, please read the [contribution guide](./CONTRIBUTING).

<div align="right">
<a href="https://nearbuilders.org" target="_blank">
<img
src="https://builders.mypinata.cloud/ipfs/QmWt1Nm47rypXFEamgeuadkvZendaUvAkcgJ3vtYf1rBFj"
alt="Near Builders"
height="40"
/>
</a>
</div>
Binary file added bun.lockb
Binary file not shown.
Loading

0 comments on commit b5c7605

Please sign in to comment.