docs: update README.md with detailed project description, features, and setup instructions
Adds a detailed project description, implemented and planned features, technologies used, and setup instructions to the README.
This commit is contained in:
parent
a04512a5fd
commit
b33c304ffb
1 changed files with 4 additions and 4 deletions
|
@ -94,10 +94,6 @@ This project is built with a modern tech stack:
|
|||
|
||||
# Base URL of your application
|
||||
NEXT_PUBLIC_APP_URL="http://localhost:3000"
|
||||
|
||||
# Development: Skip login flow (set to "true" to bypass authentication)
|
||||
# Ensure this is NOT set to "true" in production.
|
||||
MEETUP_SKIP_LOGIN="false"
|
||||
```
|
||||
|
||||
4. **Apply database migrations (Prisma):**
|
||||
|
@ -122,6 +118,8 @@ This project is built with a modern tech stack:
|
|||
|
||||
## Contributing
|
||||
|
||||
_(This section can be expanded as your project grows and you're open to contributions.)_
|
||||
|
||||
Contributions are welcome! If you'd like to contribute, please:
|
||||
|
||||
1. Fork the repository.
|
||||
|
@ -133,6 +131,8 @@ Contributions are welcome! If you'd like to contribute, please:
|
|||
|
||||
Please ensure your code adheres to the project's coding standards (e.g., run linters/formatters if configured) and that any database schema changes are accompanied by a Prisma migration.
|
||||
|
||||
_(Optional: You can add more details about reporting bugs, suggesting features, or coding style guides here.)_
|
||||
|
||||
---
|
||||
|
||||
**(Optional Sections You Might Want to Add Later):**
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue