Skip to content

Commit 9e9791d

Browse files
alsetsoalsetso
committed
feat: Complete project cleanup and preparation for GitHub publication
- Updated .gitignore with comprehensive exclusions - Created comprehensive README.md with setup instructions - Added CONTRIBUTING.md for contributor guidelines - Added MIT LICENSE file - Created env.example with all required environment variables - Removed build artifacts and temporary files - Cleaned up old Vite/React files - Organized project structure for Next.js - Added comprehensive documentation - Prepared for open source publication
1 parent c20c831 commit 9e9791d

File tree

259 files changed

+33092
-14935
lines changed

Some content is hidden

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

259 files changed

+33092
-14935
lines changed

‎.gitignore‎

Lines changed: 101 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,91 @@
1-
# Logs
2-
logs
3-
*.log
1+
# Dependencies
2+
node_modules/
43
npm-debug.log*
54
yarn-debug.log*
65
yarn-error.log*
76
pnpm-debug.log*
87
lerna-debug.log*
98

10-
node_modules
11-
dist
12-
dist-ssr
9+
# Environment variables
10+
.env
11+
.env.local
12+
.env.development.local
13+
.env.test.local
14+
.env.production.local
15+
16+
# Build outputs
17+
.next/
18+
out/
19+
dist/
20+
dist-ssr/
1321
*.local
1422

23+
# TypeScript
24+
*.tsbuildinfo
25+
next-env.d.ts
26+
27+
# Logs
28+
logs
29+
*.log
30+
31+
# Runtime data
32+
pids
33+
*.pid
34+
*.seed
35+
*.pid.lock
36+
37+
# Coverage directory used by tools like istanbul
38+
coverage/
39+
*.lcov
40+
41+
# nyc test coverage
42+
.nyc_output
43+
44+
# Dependency directories
45+
jspm_packages/
46+
47+
# Optional npm cache directory
48+
.npm
49+
50+
# Optional eslint cache
51+
.eslintcache
52+
53+
# Microbundle cache
54+
.rpt2_cache/
55+
.rts2_cache_cjs/
56+
.rts2_cache_es/
57+
.rts2_cache_umd/
58+
59+
# Optional REPL history
60+
.node_repl_history
61+
62+
# Output of 'npm pack'
63+
*.tgz
64+
65+
# Yarn Integrity file
66+
.yarn-integrity
67+
68+
# dotenv environment variables file
69+
.env.test
70+
71+
# parcel-bundler cache (https://parceljs.org/)
72+
.cache
73+
.parcel-cache
74+
75+
# Next.js build output
76+
.next
77+
78+
# Nuxt.js build / generate output
79+
.nuxt
80+
81+
# Storybook build outputs
82+
.out
83+
.storybook-out
84+
85+
# Temporary folders
86+
tmp/
87+
temp/
88+
1589
# Editor directories and files
1690
.vscode/*
1791
!.vscode/extensions.json
@@ -22,3 +96,24 @@ dist-ssr
2296
*.njsproj
2397
*.sln
2498
*.sw?
99+
100+
# OS generated files
101+
Thumbs.db
102+
ehthumbs.db
103+
104+
# Database
105+
*.db
106+
*.sqlite
107+
*.sqlite3
108+
109+
# Supabase
110+
supabase/.temp/
111+
supabase/.branches/
112+
113+
# Testing
114+
coverage/
115+
.nyc_output/
116+
117+
# Misc
118+
*.tgz
119+
*.tar.gz

‎CONTRIBUTING.md‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
# Contributing to Alset
2+
3+
Thank you for your interest in contributing to Alset! This document provides guidelines and information for contributors.
4+
5+
## 🤝 How to Contribute
6+
7+
### Reporting Bugs
8+
9+
- Use the GitHub issue tracker
10+
- Include a clear description of the bug
11+
- Provide steps to reproduce
12+
- Include browser/OS information
13+
- Add screenshots if applicable
14+
15+
### Suggesting Features
16+
17+
- Use the GitHub issue tracker
18+
- Describe the feature clearly
19+
- Explain why it would be useful
20+
- Consider the impact on existing functionality
21+
22+
### Code Contributions
23+
24+
1. **Fork the repository**
25+
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
26+
3. **Make your changes**
27+
4. **Test thoroughly**
28+
5. **Commit your changes** (`git commit -m 'Add amazing feature'`)
29+
6. **Push to the branch** (`git push origin feature/amazing-feature`)
30+
7. **Open a Pull Request**
31+
32+
## 🛠️ Development Setup
33+
34+
### Prerequisites
35+
36+
- Node.js 18+
37+
- npm, yarn, or bun
38+
- Git
39+
40+
### Local Development
41+
42+
1. Clone your fork
43+
2. Install dependencies: `npm install`
44+
3. Copy environment file: `cp env.example .env.local`
45+
4. Set up your environment variables
46+
5. Run the development server: `npm run dev`
47+
48+
### Code Style
49+
50+
- Use TypeScript for all new code
51+
- Follow the existing code style
52+
- Use Prettier for formatting
53+
- Run ESLint before committing
54+
55+
### Testing
56+
57+
- Test your changes thoroughly
58+
- Ensure all existing functionality works
59+
- Test on different browsers if applicable
60+
- Test responsive design on mobile devices
61+
62+
## 📁 Project Structure
63+
64+
```
65+
src/
66+
├── features/ # Feature-based modules
67+
│ ├── authentication/
68+
│ ├── credit-system/
69+
│ ├── property-search/
70+
│ ├── marketplace-intents/
71+
│ └── shared/
72+
├── integrations/ # Third-party service integrations
73+
└── lib/ # Utility functions and helpers
74+
```
75+
76+
## 🔧 Available Scripts
77+
78+
- `npm run dev` - Start development server
79+
- `npm run build` - Build for production
80+
- `npm run lint` - Run ESLint
81+
- `npm run type-check` - Run TypeScript type checking
82+
83+
## 📝 Commit Message Guidelines
84+
85+
Use conventional commit format:
86+
87+
```
88+
type(scope): description
89+
90+
[optional body]
91+
92+
[optional footer]
93+
```
94+
95+
Types:
96+
- `feat`: New feature
97+
- `fix`: Bug fix
98+
- `docs`: Documentation changes
99+
- `style`: Code style changes
100+
- `refactor`: Code refactoring
101+
- `test`: Adding tests
102+
- `chore`: Maintenance tasks
103+
104+
## 🚀 Pull Request Process
105+
106+
1. **Update documentation** if needed
107+
2. **Add tests** for new functionality
108+
3. **Ensure all tests pass**
109+
4. **Update CHANGELOG.md** if applicable
110+
5. **Request review** from maintainers
111+
112+
## 📋 Code Review Checklist
113+
114+
- [ ] Code follows project style guidelines
115+
- [ ] Tests are included and passing
116+
- [ ] Documentation is updated
117+
- [ ] No console.log statements in production code
118+
- [ ] Error handling is appropriate
119+
- [ ] Performance considerations are addressed
120+
121+
## 🐛 Bug Fixes
122+
123+
When fixing bugs:
124+
125+
1. **Identify the root cause**
126+
2. **Write a test** that reproduces the bug
127+
3. **Fix the issue**
128+
4. **Ensure the test passes**
129+
5. **Add regression tests** if applicable
130+
131+
## ✨ Feature Development
132+
133+
When adding features:
134+
135+
1. **Plan the feature** thoroughly
136+
2. **Consider backward compatibility**
137+
3. **Add appropriate tests**
138+
4. **Update documentation**
139+
5. **Consider performance impact**
140+
141+
## 🔒 Security
142+
143+
- Never commit sensitive information
144+
- Follow security best practices
145+
- Report security vulnerabilities privately
146+
- Use environment variables for secrets
147+
148+
## 📚 Documentation
149+
150+
- Keep documentation up to date
151+
- Use clear, concise language
152+
- Include examples when helpful
153+
- Update README.md for significant changes
154+
155+
## 🎯 Getting Help
156+
157+
- Check existing documentation
158+
- Search existing issues
159+
- Ask questions in GitHub Discussions
160+
- Join the community chat (if available)
161+
162+
## 📄 License
163+
164+
By contributing, you agree that your contributions will be licensed under the same license as the project.
165+
166+
## 🙏 Recognition
167+
168+
Contributors will be recognized in:
169+
- README.md contributors section
170+
- Release notes
171+
- Project documentation
172+
173+
---
174+
175+
Thank you for contributing to Alset! 🚀

0 commit comments

Comments
 (0)