Skip to content

Commit

Permalink
Merge pull request #5 from ozma-io/docs/add-cursor-rules-and-railway
Browse files Browse the repository at this point in the history
docs: add cursor rules and railway quick start
  • Loading branch information
kirill-markin authored Feb 17, 2025
2 parents 7091813 + ace8aed commit 2bf2da6
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 14 deletions.
29 changes: 29 additions & 0 deletions .cursorrules
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
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

Ozma is an open-source CRM/ERP platform that allows for the rapid development of customizable enterprise systems. Build and tailor CRM/ERP solutions quickly and efficiently to meet your business needs.

<div align="left">
<a href="https://ozma.io/ai-business-app-builder/">Get started</a> |
<a href="https://discord.gg/Mc8YcF63yt">Discord</a> |
<a href="https://wiki.ozma.io/en/home">Docs</a> |
<a href="https://ozma.io">Website</a>
<br />
<br />
</div>
## Quick Start
1. Click "Deploy on Railway" button below
2. Open Railway block "ozma" after deployment
3. Access your app at the generated URL (e.g., `ozma-production-xxxx.up.railway.app`)

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.com/template/xgJwGP)

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
## Resources

[![Discord](https://img.shields.io/discord/938075538961080350.svg?label=Chat&logo=discord&color=7289da)](https://discord.gg/Mc8YcF63yt)

Expand All @@ -30,13 +28,17 @@ Ozma is an open-source CRM/ERP platform that allows for the rapid development of
<br>
-->

![](https://ozma.io/assets/images/main/preview.png)

## Features

- **Low-Code Development**: Accelerate your system development.
- **Fully Customizable**: Adaptable to any business process.
- **Developer-Friendly**: No expensive training required.
<div align="center">
<a href="https://ozma.io/ai-business-app-builder/">Get started</a> |
<a href="https://discord.gg/Mc8YcF63yt">Discord</a> |
<a href="https://wiki.ozma.io/en/home">Docs</a> |
<a href="https://ozma.io">Website</a>
<br />
<br />
</div>

## Table of Contents

Expand Down

0 comments on commit 2bf2da6

Please sign in to comment.