-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add cursor rules and railway quick start
- Add .cursorrules file with project overview - Update README.md with Railway deployment instructions
- Loading branch information
1 parent
7091813
commit ace8aed
Showing
2 changed files
with
45 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Ozma - Open-source CRM/ERP Platform | ||
|
||
## Project Overview | ||
- Open-source CRM/ERP platform for rapid development of customizable enterprise systems | ||
- Built with low-code development approach and full customization capabilities | ||
- Uses Keycloak for authentication and user management | ||
- Includes report generator functionality | ||
- For detailed deployment instructions and full documentation, refer to @README.md | ||
|
||
## Key Components | ||
- Frontend: Web application (port 9080 in dev) | ||
- Backend: API services | ||
- Auth: Keycloak integration | ||
- Database: PostgreSQL | ||
- Infrastructure: Docker-based deployment | ||
|
||
## Development Setup | ||
- Uses Docker Compose for local development | ||
- Environment configs: env.dev.example (dev) and env.production.example (prod) | ||
- Default ports: 9080 (dev), 80/443 (prod) | ||
- Admin credentials in respective .env files | ||
|
||
## Project Structure | ||
/docker/ # Docker configuration files | ||
/docs/ # Documentation | ||
/frontend/ # Web application frontend | ||
/backend/ # API and services | ||
/scripts/ # Utility scripts | ||
/migrations/ # Database migrations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters