Skip to content

Commit

Permalink
chore: init
Browse files Browse the repository at this point in the history
  • Loading branch information
SamHillierDev committed Nov 3, 2024
0 parents commit a4b0a57
Show file tree
Hide file tree
Showing 43 changed files with 5,266 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @SamHillierDev
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/01-suggest-changes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "✍️ ​​Suggest Changes"
description: Help me improve my Final Year Project by suggesting changes.
labels: [suggestion]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help me improve my Final Year Project with your suggestions.
- type: input
id: url
attributes:
label: URL
description: Please provide the URL of where you are suggesting changes to.
placeholder: https://enjindex.com
validations:
required: true
- type: textarea
id: suggestions
attributes:
label: Suggestions
description: What changes would you like to suggest?
placeholder: Enter your suggestions here.
validations:
required: true
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: "🐛 ​​Bug Report"
description: Report an issue or possible bug.
labels: [bug]
assignees: []
body:
- type: input
id: url
attributes:
label: What is the URL where the issue is happening.
placeholder: https://enjindex.com
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Chrome
- Safari
- Microsoft Edge
- Firefox
- Opera
- Other
- type: textarea
id: bug
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is and the steps to reproduce.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Output from browser console (if any)
description: Please provide any relevant log output.
- type: checkboxes
id: participation
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this issue.
required: false
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/03-feature-suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: "✨ ​​Feature Suggestion"
description: Is there a feature you'd like to see? Let me know!
labels: [feature request]
assignees: []
body:
- type: textarea
id: feature
attributes:
label: Feature Description
description: Please provide a detailed description of the feature you are suggesting and how it would help you/others.
validations:
required: true
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/04-something-else.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: "🤷‍♂️ ​​Something else"
description: If none of the above templates fit your needs, please use this template to submit your issue.
labels: []
assignees: []
body:
- type: textarea
id: description
attributes:
label: Description
description: Please provide a detailed description of the issue.
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 📝 ​​Typo or Grammatical Mistake
url: https://github.com/Zyphaex/enjindex/pulls
about: Please submit a pull request instead of reporting it as an issue.
- name: 🤝 ​Community
url: https://discord.com/invite/XfZHVfPr9C
about: Join my community Discord server.
47 changes: 47 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Deploy static content to Pages

on:
push:
branches: ['main']

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: 'pages'
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: 'npm'
cache-dependency-path: frontend/package-lock.json
- name: Install dependencies
run: npm install
working-directory: ./frontend
- name: Build
run: npm run build
working-directory: ./frontend
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './frontend/dist'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Environment Variables
.env

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
enjindex.com
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# ENJindex, explore NFTs and crypto collectibles

<div align="center">
<img src="frontend/src/assets/images/ntuLogoTitle.webp" alt="Nottingham Trent University Logo" width="250">
</div>

---

ENJindex, explore NFTs and crypto collectibles.
Final Year Project (FYP) for the Computer Science 2024 academic year at [Nottingham Trent University](https://ntu.ac.uk) (NTU).

## Requirements

Make sure you have Node and NPM installed:

```bash
node -v
# v22.10.0
```

```bash
npm -v
# 10.9.0
```

## Installation

Run the commands:

```bash
cd frontend
```

```bash
npm install
```

```bash
npm run dev
```

## Security Vulnerabilities

Please review our [security policy](https://github.com/SamHillierDev/enjindex/security/policy) on how to report security vulnerabilities.

## Credits

- [Sam Hillier](https://github.com/SamHillierDev)
- [All Contributors](https://github.com/SamHillierDev/enjindex/contributors)

## License

Please see [License File](https://github.com/SamHillierDev/enjindex/blob/main/LICENSE) for more information.

© 2024 Samuel Hillier. All Rights Reserved.
18 changes: 18 additions & 0 deletions frontend/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parser: '@typescript-eslint/parser',
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
19 changes: 19 additions & 0 deletions frontend/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>ENJindex, explore NFTs</title>
<meta name="description" content="ENJindex, explore NFTs and crypto collectibles. Final Year Project 2024 @ Nottingham Trent University developed by Zyphaex."/>
<meta property="og:title" content="ENJindex, explore NFTs"/>
<meta property="og:description" content="ENJindex, explore NFTs and crypto collectibles. Final Year Project 2024 @ Nottingham Trent University developed by Zyphaex."/>
<meta property="og:image" content="https://raw.githubusercontent.com/Zyphaex/enjindex/main/frontend/src/assets/images/enjindex.png"/>
<meta property="og:type" content="website"/>
<meta property="og:url" content="https://enjindex.com"/>
<link rel="icon" type="image/svg+xml" href="/enjindex.svg"/>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
Loading

0 comments on commit a4b0a57

Please sign in to comment.