Skip to content

Commit ba490e7

Browse files
Updaing readme
1 parent d81cc1a commit ba490e7

File tree

1 file changed

+14
-105
lines changed

1 file changed

+14
-105
lines changed

README.md

Lines changed: 14 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -189,137 +189,46 @@ php artisan serve
189189

190190
## Features Overview
191191

192-
### 🔐 Authentication System
192+
### Authentication System
193193
Complete authentication flow with:
194194
- User registration with email verification
195195
- Secure login with rate limiting
196196
- Password reset functionality
197197
- Remember me functionality
198198
- Session management
199199

200-
### 👥 User Management
200+
### User Management
201201
Administrative interface for:
202202
- Viewing all users
203203
- Editing user information
204204
- Deleting users
205205

206-
### 📧 Email Features
206+
### Email Features
207207
- Email verification for new registrations
208208
- Password reset emails
209209
- Configurable mail settings
210210

211-
### 🛡️ Security Features
211+
### Security Features
212212
- Password hashing with bcrypt
213213
- CSRF protection
214214
- Rate limiting on login attempts
215215
- Secure session handling
216216
- Input validation
217217

218-
## Development Commands
219-
220-
### Run Tests
221-
```bash
222-
php artisan test
223-
```
224-
225-
### Code Formatting
226-
```bash
227-
./vendor/bin/pint
228-
```
229-
230-
## MongoDB Specific Features
231-
232-
### Document Structure
233-
Users are stored as MongoDB documents with flexible schema support:
234-
235-
```json
236-
{
237-
"_id": ObjectId("..."),
238-
"name": "John Doe",
239-
"email": "john@example.com",
240-
"password": "$2y$12$...",
241-
"email_verified_at": ISODate("..."),
242-
"created_at": ISODate("..."),
243-
"updated_at": ISODate("...")
244-
}
245-
```
246-
247-
### Indexing
248-
Consider adding indexes for better performance:
249-
250-
```javascript
251-
// In MongoDB shell
252-
db.users.createIndex({ "email": 1 }, { unique: true })
253-
db.users.createIndex({ "created_at": -1 })
254-
```
255-
256-
## Customization
257-
258-
### Adding New Fields
259-
To add fields to the User model:
260-
261-
1. Update the `$fillable` array in `app/Models/User.php`
262-
2. Update validation rules in request classes
263-
3. Update forms and views accordingly
264-
265-
### Custom Authentication
266-
The authentication system can be customized by modifying controllers in `app/Http/Controllers/Auth/`
267218

268219
## What's Included
269220

270221
This starter kit provides:
271222

272-
**Database Configuration** - MongoDB connection ready to use
273-
**User Model** - MongoDB-compatible User model with authentication
274-
**Authentication Controllers** - Complete auth flow (login, register, password reset, etc.)
275-
**User Management** - CRUD operations for user administration
276-
**Profile Management** - User profile editing capabilities
277-
**Form Requests** - Validation classes for user input
278-
**Routes** - Pre-defined routes for all functionality
279-
**Security** - Built-in security features and rate limiting
280-
281-
## Troubleshooting
282-
283-
### MongoDB Connection Issues
284-
1. Ensure MongoDB is running
285-
2. Check connection string in `.env`
286-
3. Verify MongoDB extension is installed: `php -m | grep mongodb`
287-
288-
### Permission Issues
289-
```bash
290-
chmod -R 775 storage bootstrap/cache
291-
```
292-
293-
### Clear Cache
294-
```bash
295-
php artisan config:clear
296-
php artisan cache:clear
297-
php artisan route:clear
298-
```
299-
300-
## Contributing
301-
302-
1. Fork the repository
303-
2. Create a feature branch
304-
3. Make your changes
305-
4. Add tests if applicable
306-
5. Submit a pull request
307-
308-
## License
309-
310-
This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
311-
312-
## Support
313-
314-
For issues and questions:
315-
- Check the [Issues](https://github.com/aasawariMongoDB/mongodb-starter-kit-for-laravel/issues) page
316-
- Create a new issue if needed
317-
- Contact: aasawari.sahasrabuddhe@mongodb.com
318-
319-
## Acknowledgments
223+
**Database Configuration** - MongoDB connection ready to use
224+
**User Model** - MongoDB-compatible User model with authentication
225+
**Authentication Controllers** - Complete auth flow (login, register, password reset, etc.)
226+
**User Management** - CRUD operations for user administration
227+
**Profile Management** - User profile editing capabilities
228+
**Form Requests** - Validation classes for user input
229+
**Routes** - Pre-defined routes for all functionality
230+
**Security** - Built-in security features and rate limiting
320231

321-
- Laravel Framework
322-
- MongoDB Laravel Integration
323-
- Laravel Breeze for authentication scaffolding
232+
For learning more about integration MongoDB in Laravel applications, refer to the [official Laravel Documentations](https://laravel.com/docs/12.x/mongodb).
324233

325-
---
234+
Start building your Laravel + MongoDB-powered application!

0 commit comments

Comments
 (0)