Skip to content

Commit 3837fc6

Browse files
sean0205sean0205
committed
Initial release
0 parents  commit 3837fc6

File tree

566 files changed

+51754
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

566 files changed

+51754
-0
lines changed

‎.env.example

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
ENV=development
2+
3+
# Prisma Config #
4+
DATABASE_URL="postgresql://user:password@host:port/database?sslmode=mode&connection_limit=limit"
5+
6+
# Next API Config #
7+
NEXT_PUBLIC_API_URL=http://localhost:3333/api
8+
9+
# Storage Configuration (AWS S3 or DigitalOcean Spaces)
10+
STORAGE_TYPE=digitalocean
11+
12+
STORAGE_ACCESS_KEY_ID=access_key_id
13+
STORAGE_SECRET_ACCESS_KEY=secret_access_key
14+
STORAGE_REGION=ams3
15+
STORAGE_BUCKET=crudhunt
16+
STORAGE_ENDPOINT=https://keenthemes.ams3.digitaloceanspaces.com
17+
STORAGE_FORCE_PATH_STYLE=true
18+
STORAGE_CDN_URL=https://keenthemes.ams3.cdn.digitaloceanspaces.com/crudhunt

‎.gitignore

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# dependencies
2+
/node_modules
3+
/.pnp
4+
.pnp.*
5+
.yarn/*
6+
!.yarn/patches
7+
!.yarn/plugins
8+
!.yarn/releases
9+
!.yarn/versions
10+
11+
# testing
12+
/coverage
13+
14+
# next.js
15+
/.next/
16+
/out/
17+
18+
# production
19+
/build
20+
21+
# misc
22+
.DS_Store
23+
*.pem
24+
25+
# debug
26+
npm-debug.log*
27+
yarn-debug.log*
28+
yarn-error.log*
29+
30+
# vercel
31+
.vercel
32+
33+
# typescript
34+
*.tsbuildinfo
35+
next-env.d.ts
36+
37+
.env
38+
.env.production

‎.prettierignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
.next
3+
dist
4+
public
5+
build
6+
prisma

‎.prettierrc

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 2,
4+
"endOfLine": "lf",
5+
"singleQuote": true,
6+
"trailingComma": "all",
7+
"bracketSpacing": true,
8+
"semi": true,
9+
"bracketSameLine": false,
10+
"jsxSingleQuote": false,
11+
"arrowParens": "always",
12+
"importOrder": [
13+
"<BUILTIN_MODULES>",
14+
"^(react/(.*)$)|^(react$)",
15+
"^(next/(.*)$)|^(next$)",
16+
"<THIRD_PARTY_MODULES>",
17+
"^types$",
18+
"^@/types/(.*)$",
19+
"^@/config/(.*)$",
20+
"^@/lib/(.*)$",
21+
"^@/hooks/(.*)$",
22+
"^@/providers/(.*)$",
23+
"^@/services/(.*)$",
24+
"^@/components/ui/(.*)$",
25+
"^@/components/(.*)$",
26+
"^@/app/(.*)$",
27+
"^[./]",
28+
"^@/styles/(.*)$"
29+
],
30+
"importOrderCaseSensitive": false,
31+
"plugins": [
32+
"prettier-plugin-tailwindcss",
33+
"@ianvs/prettier-plugin-sort-imports"
34+
]
35+
}

‎CONTRIBUTING.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to CrudHunt
2+
3+
Thank you for considering contributing to CrudHunt! Your contributions help improve the project for everyone. Please follow these guidelines to ensure a smooth collaboration. If you need any help, feel free to reach out us via [@crudhunt](https://x.com/crudhunt).
4+
5+
## Getting Started
6+
7+
1. **Fork the Repository**: Click the 'Fork' button on the top right of the repository page.
8+
2. **Clone Your Fork**:
9+
```sh
10+
git clone https://github.com/keenthemes/crudhunt.git
11+
cd crudhunt
12+
```
13+
3. **Set Up Upstream Remote**:
14+
```sh
15+
git remote add upstream https://github.com/keenthemes/crudhunt.git
16+
```
17+
18+
## Setting Up the Development Environment
19+
20+
1. Install dependencies:
21+
```sh
22+
npm install
23+
```
24+
2. Run format:
25+
```sh
26+
npm run format
27+
```
28+
3. Lint your code:
29+
```sh
30+
npm run lint
31+
```
32+
33+
## Format and lint your code
34+
35+
Ensure your code is formatted and linted before submitting any changes. Run the following commands:
36+
37+
```sh
38+
npm run format
39+
npm run lint
40+
```
41+
42+
## Commit Convention
43+
44+
Please follow the commit message format below:
45+
46+
- **feat:** All changes that introduce completely new code or new features.
47+
- **fix:** Changes that fix a bug (ideally, reference an issue if present).
48+
- **refactor:** Any code-related change that is not a fix nor a feature.
49+
- **docs:** Changing existing or creating new documentation (e.g., README, usage docs).
50+
- **build:** Changes regarding the build of the software, dependencies, or adding new dependencies.
51+
- **ci:** Changes regarding the configuration of continuous integration (e.g., GitHub Actions, CI systems).
52+
- **chore:** Repository changes that do not fit into any of the above categories.
53+
54+
**Example commit message:**
55+
56+
```sh
57+
feat(components): add new prop to the avatar component
58+
```
59+
60+
## Submitting a Pull Request
61+
62+
1. Create a new branch:
63+
```sh
64+
git checkout -b feature-branch
65+
```
66+
2. Make changes and commit:
67+
```sh
68+
git add .
69+
git commit -m "Add new feature"
70+
```
71+
3. Push to your fork:
72+
```sh
73+
git push origin feature-branch
74+
```
75+
4. Open a pull request:
76+
- Go to the [CrudHunt GitHub repository](https://github.com/keenthemes/crudhunt.git).
77+
- Click on 'New Pull Request'.
78+
- Select your branch and submit the PR.
79+
80+
## Code Review
81+
82+
Code is reviewed under strict terms to make sure it matches CrudHunt code standards and design guidelines.
83+
84+
---
85+
86+
Thank you for contributing! 🚀

‎LICENSE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## License
2+
3+
Guidelines on usage rights, restrictions, and use of Crudhunt.
4+
5+
Copyright &copy; 2025 [Keenthemes Inc.](https://keenthemes.com)
6+
7+
- You are free to use Crudhunt's components and CRUD modules in both personal and commercial projects.
8+
9+
- Redistribution or resale of the code as a competing offering is not permitted.
10+
11+
Our goal is to keep Crudhunt free and accessible while maintaining fair usage and sustainable development.

0 commit comments

Comments
 (0)