Skip to content

Commit

Permalink
build(repo): update readme and add gitattributes
Browse files Browse the repository at this point in the history
  • Loading branch information
Favo02 committed Apr 12, 2024
1 parent e909972 commit c59dbf7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 22 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/frontend/src/**/* linguist-generated
55 changes: 33 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,45 @@
<img src="https://github.com/Favo02/cess-advisor/assets/59796435/f71a96e5-5769-46e4-a547-93cff46b1b7b" width="100" align="right" alt="Logo" />
<img src="https://github.com/Favo02/cess-advisor/assets/59796435/f71a96e5-5769-46e4-a547-93cff46b1b7b" width="150" align="right" alt="Logo" />

## Cess Advisor
# Cess Advisor

Cess Advisor is a **stupid** yet really **useful** web app that helps you decide whether a _decent toilet_ is available or you _should suffer_.
**Cess Advisor** 🐪🚽 is a _stupid_ yet really _useful_ web app that helps you find a _suitable toilet_ when you are in a hurry.

> [!CAUTION]
> The app is still in early development, it is not yet ready for production use.
> _In other words you could be able to do something bad, but I trust you will not do it._

### Tech stack
## Tech stack

- Backend: **OCaml** _(I decided to suffer too building this thing, but in the end I enjoyed OCaml really much)_
In short: **OCaml** 🐪 + **JavaScript** ⚛️ + **PostgreSQL** 🐘 + Docker 🐳 + GitHub Actions 🚀

> [!TIP]
> If you want to preserve your mental health, you should **NOT** write JavaScript code. OCaml is just better.
<details>
<summary>Detailed tech stack</summary>

- Backend: **OCaml** 🐪
- [Sihl](https://github.com/oxidizing/sihl): OCaml framework for building web apps
- [Caqti](https://github.com/paurkedal/ocaml-caqti): OCaml library for interacting with databases
- [Yojson](https://github.com/ocaml-community/yojson): OCaml library for JSON serialization
- [Validate](https://github.com/Axot017/validate): OCaml library for validating schemas

- ~~Frontend: **JavaScript** _(much much much much worse than OCaml)_~~
- ~~[React](https://reactjs.org/): JavaScript framework for frontend web development~~
- ~~[Vite](https://vitejs.dev/): React build tool~~
- ~~[Tailwind CSS](https://tailwindcss.com/): CSS framework~~
- ~~[Shadcn-ui](https://ui.shadcn.com/): React components library~~
- Frontend: **JavaScript** ⚛️
- [React](https://reactjs.org/): JavaScript framework for frontend web development
- [Vite](https://vitejs.dev/): React build tool
- [Tailwind CSS](https://tailwindcss.com/): CSS framework
- [Shadcn-ui](https://ui.shadcn.com/): React components library

- Database:
- Database: 🐘
- [PostgreSQL](https://www.postgresql.org/): relational database

- Deployment:
- Deployment: 🐳
- [Docker](https://www.docker.com/): containerization
- [GitHub Actions](https://docs.github.com/en/actions): CI/CD

</details>

### Commit convention
## Conventions

<details>
<summary>Commit convention</summary>

This project follows the following **commit convention**: `<type>(<part>/<scope>): <summary>`

Expand All @@ -48,15 +57,17 @@ This project follows the following **commit convention**: `<type>(<part>/<scope>
- `handlers`: request handlers
- `middlewares`: middleware functions
- `utils`: utility module
- ~~`fe/`: frontend~~
- ~~`components`: components~~
- ~~`pages`: pages _(routing)_~~
- ~~`services`: interaction with backend API~~
- ~~`validators`: form validators~~
- `fe/`: frontend
- `components`: components
- `pages`: pages _(routing)_
- `services`: interaction with backend API
- `validators`: form validators
- `db/`: database
- `tables`: tables
- `repo`: repository _(omit scope)_

- **Summary**: commit summary, present tense, start with lowercase, no period at the end

_Adding new scopes is allowed if necessary, add it to the list above._
_Adding new scopes is allowed if necessary, just add it to the list above._

</details>

0 comments on commit c59dbf7

Please sign in to comment.