Skip to content

Commit

Permalink
feat(docs): added code climate and image
Browse files Browse the repository at this point in the history
  • Loading branch information
yyewolf committed Aug 11, 2023
1 parent c92b2aa commit 837036a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .codeclimate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## exclude auto generated files from codeclimate analysis
exclude_patterns:
- "backend/autogen/bar.gen.go"
- "frontend/src/lib/api/*"
- "config/"
- "db/"
- "dist/"
- "features/"
- "**/node_modules/"
- "script/"
- "**/spec/"
- "**/test/"
- "**/tests/"
- "Tests/"
- "**/vendor/"
- "**/*_test.go"
- "**/*.d.ts"
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
<p align="center">
<p align="center">
<a href="https://github.com/yyewolf/bar/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/yyewolf/bar.svg?style=flat-square"></a>
<a href="https://travis-ci.org/yyewolf/bar"><img alt="Travis" src="https://travis-ci.org/yyewolf/bar.svg?branch=master"></a>
<a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat-square"></a>
<a href="https://codeclimate.com/github/yyewolf/bar/test_coverage"><img src="https://api.codeclimate.com/v1/badges/d9fcf617937d6026221f/test_coverage" /></a>
<a href="https://codeclimate.com/github/yyewolf/bar/maintainability"><img src="https://api.codeclimate.com/v1/badges/d9fcf617937d6026221f/maintainability" /></a>
<a href="https://goreportcard.com/report/github.com/yyewolf/bar/backend"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/yyewolf/bar/backend"></a>
<a href="https://godoc.org/github.com/yyewolf/bar/backend"><img src="https://godoc.org/github.com/yyewolf/bar/backend?status.svg" alt="GoDoc"></a>
</p>
</p>

# Le Bar

**Le Bar** is a monorepository containing both the frontend and backend components of a system designed to manage various aspects of a bar's operations. This document provides an overview of the project structure, setup instructions, and available commands.

## Presentation

<img src="docs/image.png" alt="presentation" width="50%">

## Dependencies

Before you begin, ensure you have the following dependencies installed:
Expand Down
Binary file added docs/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 837036a

Please sign in to comment.