Skip to content

Commit

Permalink
Add GitHub Actions workflow for Docker build
Browse files Browse the repository at this point in the history
  • Loading branch information
barslmn committed Jan 8, 2025
1 parent 27afd0f commit 41efe5c
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Docker Build

on:
push:
branches:
- release

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3

- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build and push
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: |
ghcr.io/${{ github.repository }}:latest
ghcr.io/${{ github.repository }}:${{ github.sha }}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Canvas

Canvas is a Django-based web application for managing and analyzing chip samples, variants, and generating reports.

## Features

- Chip sample management and analysis
- Report generation and management
- Variant analysis and modal viewing
- CNV (Copy Number Variation) tracking
- Sample search functionality
- Interactive sidebar navigation

## Prerequisites

- Docker
- Docker Compose

## Installation

1. Clone the repository:
```bash
git clone [repository-url]
cd canvas
```

2. Start the application using Docker Compose:
```bash
docker compose up -d
```

The application will be available at `http://localhost:8000` (or your configured port).

To stop the application:
```bash
docker compose down
```

## Project Structure

- `admin.py` - Django admin configurations
- `models.py` - Database models
- `views.py` - View controllers
- `urls.py` - URL routing
- `templates/` - HTML templates
- `components/` - Reusable UI components
- `partials/` - Partial template fragments

## Management Commands

The project includes custom management commands:
- `associate_files` - For file association management

## Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 41efe5c

Please sign in to comment.