DHBW-WE/MeetUp
5
0
Fork 0
Code Issues 7 Pull requests 5 Projects 1 Releases 5 Packages 1 Wiki Activity Actions

docs: update README.md with detailed project description, features, and setup instructions
Some checks failed
docker-build / docker (pull_request) Failing after 2m1s
Details
container-scan / Container Scan (pull_request) Failing after 6m59s
Details

Browse source 
Adds a detailed project description, implemented and planned features, technologies used, and setup instructions to the README.
This commit is contained in:
Maximilian Liebmann 2025-05-09 22:46:02 +02:00
parent a04512a5fd
commit b33c304ffb
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -94,10 +94,6 @@ This project is built with a modern tech stack:
# Base URL of your application # Base URL of your application
NEXT_PUBLIC_APP_URL="http://localhost:3000" 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):** 4. **Apply database migrations (Prisma):**
@ -122,6 +118,8 @@ This project is built with a modern tech stack:
## Contributing ## 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: Contributions are welcome! If you'd like to contribute, please:
1. Fork the repository. 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. 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):** **(Optional Sections You Might Want to Add Later):**