Skip to content

Commit 55ef650

Browse files
committed
Initial open source release
1 parent 0d84b76 commit 55ef650

4 files changed

Lines changed: 52 additions & 46 deletions

File tree

.github/workflows/ci.yml

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ jobs:
144144
145145
- name: Create deployment package
146146
run: |
147-
tar -czf oreno-grc-${{ github.sha }}.tar.gz \
147+
tar -czf oreno-${{ github.sha }}.tar.gz \
148148
--exclude='.git' \
149149
--exclude='.venv' \
150150
--exclude='__pycache__' \
@@ -156,33 +156,35 @@ jobs:
156156
- name: Upload build artifacts
157157
uses: actions/upload-artifact@v3
158158
with:
159-
name: oreno-grc-build-${{ github.sha }}
160-
path: oreno-grc-${{ github.sha }}.tar.gz
161-
162-
docker:
163-
runs-on: ubuntu-latest
164-
needs: [test]
165-
if: github.ref == 'refs/heads/main'
166-
167-
steps:
168-
- uses: actions/checkout@v4
169-
170-
- name: Set up Docker Buildx
171-
uses: docker/setup-buildx-action@v3
172-
173-
- name: Login to Docker Hub
174-
uses: docker/login-action@v3
175-
with:
176-
username: ${{ secrets.DOCKER_USERNAME }}
177-
password: ${{ secrets.DOCKER_PASSWORD }}
178-
179-
- name: Build and push Docker image
180-
uses: docker/build-push-action@v5
181-
with:
182-
context: .
183-
push: true
184-
tags: |
185-
yourusername/oreno-grc:latest
186-
yourusername/oreno-grc:${{ github.sha }}
187-
cache-from: type=gha
188-
cache-to: type=gha,mode=max
159+
name: oreno-build-${{ github.sha }}
160+
path: oreno-${{ github.sha }}.tar.gz
161+
162+
# Docker build (optional - requires Docker Hub credentials)
163+
# Uncomment and configure secrets if you want to enable Docker builds
164+
# docker:
165+
# runs-on: ubuntu-latest
166+
# needs: [test]
167+
# if: github.ref == 'refs/heads/main'
168+
#
169+
# steps:
170+
# - uses: actions/checkout@v4
171+
#
172+
# - name: Set up Docker Buildx
173+
# uses: docker/setup-buildx-action@v3
174+
#
175+
# - name: Login to Docker Hub
176+
# uses: docker/login-action@v3
177+
# with:
178+
# username: ${{ secrets.DOCKER_USERNAME }}
179+
# password: ${{ secrets.DOCKER_PASSWORD }}
180+
#
181+
# - name: Build and push Docker image
182+
# uses: docker/build-push-action@v5
183+
# with:
184+
# context: .
185+
# push: true
186+
# tags: |
187+
# oumafreddy/oreno:latest
188+
# oumafreddy/oreno:${{ github.sha }}
189+
# cache-from: type=gha
190+
# cache-to: type=gha,mode=max

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
**A comprehensive, open-source Governance, Risk, and Compliance (GRC) platform**
1212

13-
[Documentation](https://github.com/yourusername/oreno-grc/wiki)[Contributing](CONTRIBUTING.md)[Issues](https://github.com/yourusername/oreno-grc/issues)[Discussions](https://github.com/yourusername/oreno-grc/discussions)
13+
[Documentation](https://github.com/oumafreddy/oreno/wiki)[Contributing](CONTRIBUTING.md)[Issues](https://github.com/oumafreddy/oreno/issues)[Discussions](https://github.com/oumafreddy/oreno/discussions)
1414
</div>
1515

1616
---
@@ -38,8 +38,8 @@ Oreno GRC is a modern, multi-tenant Governance, Risk, and Compliance platform bu
3838

3939
1. **Clone the repository**
4040
```bash
41-
git clone https://github.com/yourusername/oreno-grc.git
42-
cd oreno-grc
41+
git clone https://github.com/oumafreddy/oreno.git
42+
cd oreno
4343
```
4444

4545
2. **Create virtual environment**
@@ -55,7 +55,7 @@ Oreno GRC is a modern, multi-tenant Governance, Risk, and Compliance platform bu
5555

5656
4. **Configure environment**
5757
```bash
58-
cp .env.example .env.oreno
58+
cp env.example .env.oreno
5959
# Edit .env.oreno with your configuration
6060
```
6161

@@ -105,7 +105,7 @@ Oreno GRC follows a modular, multi-tenant architecture designed for scalability
105105
## 📁 Project Structure
106106

107107
```
108-
oreno-grc/
108+
oreno/
109109
├── 📁 apps/ # Django applications
110110
│ ├── 🔍 audit/ # Audit management
111111
│ ├── ⚠️ risk/ # Risk management
@@ -164,12 +164,16 @@ coverage report
164164
5. Configure static file serving
165165
6. Set up SSL certificates
166166

167-
### Docker Support
167+
### Docker Support (Optional)
168+
Docker configuration is provided for convenience but is not required for development:
169+
168170
```bash
169-
# Build and run with Docker
171+
# Build and run with Docker (requires Docker installed)
170172
docker-compose up --build
171173
```
172174

175+
**Note**: Docker is optional. You can run Oreno GRC directly with Python without Docker.
176+
173177
## 🤝 Contributing
174178

175179
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
@@ -194,10 +198,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
194198

195199
## 📞 Support
196200

197-
- 📖 [Documentation](https://github.com/yourusername/oreno-grc/wiki)
198-
- 💬 [Discussions](https://github.com/yourusername/oreno-grc/discussions)
199-
- 🐛 [Issue Tracker](https://github.com/yourusername/oreno-grc/issues)
200-
- 📧 Email: support@oreno.tech
201+
- 📖 [Documentation](https://github.com/oumafreddy/oreno/wiki)
202+
- 💬 [Discussions](https://github.com/oumafreddy/oreno/discussions)
203+
- 🐛 [Issue Tracker](https://github.com/oumafreddy/oreno/issues)
204+
- 📧 Email: fredouma@oreno.tech | oumafredomondi@gmail.com
201205

202206
---
203207

docker-compose.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ services:
44
db:
55
image: postgres:15
66
environment:
7-
POSTGRES_DB: oreno_grc
7+
POSTGRES_DB: oreno
88
POSTGRES_USER: oreno_user
99
POSTGRES_PASSWORD: oreno_password
1010
volumes:
@@ -27,7 +27,7 @@ services:
2727
environment:
2828
- DJANGO_DEBUG=True
2929
- DB_ENGINE=django.db.backends.postgresql
30-
- DB_NAME=oreno_grc
30+
- DB_NAME=oreno
3131
- DB_USER=oreno_user
3232
- DB_PASS=oreno_password
3333
- DB_HOST=db
@@ -44,7 +44,7 @@ services:
4444
environment:
4545
- DJANGO_DEBUG=True
4646
- DB_ENGINE=django.db.backends.postgresql
47-
- DB_NAME=oreno_grc
47+
- DB_NAME=oreno
4848
- DB_USER=oreno_user
4949
- DB_PASS=oreno_password
5050
- DB_HOST=db

env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1
88

99
# Database Configuration
1010
DB_ENGINE=django.db.backends.postgresql
11-
DB_NAME=oreno_grc
11+
DB_NAME=oreno
1212
DB_USER=oreno_user
1313
DB_PASS=oreno_password
1414
DB_HOST=localhost

0 commit comments

Comments
 (0)