docs: Added a README.md

.github/workflows/ci.yml

@@ -19,8 +19,9 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      - run: docker build -t $IMAGE_NAME:$GITHUB_JOB .
-      - run: docker push $IMAGE_NAME:$GITHUB_JOB
+      - run: docker build -t $IMAGE_NAME:commit-${GITHUB_SHA:0:8} .
+      - run: docker tag $IMAGE_NAME $IMAGE_NAME:latest
+      - run: docker push $IMAGE_NAME --all-tags
   release:
     runs-on: ubuntu-latest
     needs: [ build ]

README.md

@@ -0,0 +1,39 @@
+# Workflow
+
+Workflow is a project management software that will help you to manage project of small to medium scale. This provides simple and easy to use Kanban board track the progress of the project. In the users can create multiple organizations and multiple projects in them and users can work across many projects and companies. 
+
+This was mainly developed to show case my skills of creating enterprise grade applications using **.NET 6** as the backend **Blazor** to render the frontend UIs.
+
+## Demo - https://workflow.isala.me/
+Username - suffect \
+Password - Abcd@1234
+> Note: Database will be resetted after each session
+
+## Run locally
+
+### Development
+> Note: .NET 6.0 SDK needs to be installed
+```bash
+git clone https://github.com/MrSupiri/WorkFlow.git
+cd WorkFlow/WorkFlow/Server
+dotnet run "WorkFlow.Server.csproj"
+```
+
+### Preview
+```bash
+docker run --rm -p 5021:443 -p 7021:80 ghcr.io/mrsupiri/workflow:latest
+```
+
+### Screenshots
+#### Home Page
+![Home Page](images/home-page.png)
+#### Kanban Board
+![Kanban Board](images/project-view.png)
+#### Report Forecasting
+![Report Forecasting](images/forecasting.png)
+#### Edit Ticket
+![Edit Ticket](images/ticket-view.png)
+#### User Settings
+![User Settings](images/user-profile.png)
+#### Company Settings
+![Company Settings](images/comapny-settings.png)