63 lines
1.4 KiB
Markdown
63 lines
1.4 KiB
Markdown
<div align="center">
|
|
<img src="./static/assets/icon-512-rounded.png" alt="logo" width="150px" height="150px"/>
|
|
<h1><a href="https://cohabit.fr" target="_blank">Coh@bit.fr</a></h1>
|
|
<p>Site web de cohabit</p>
|
|
</div>
|
|
|
|
[]()
|
|
|
|
## 👀 Vue d'ensemble du projet
|
|
|
|
TODO
|
|
|
|
## 💭 Choix et design
|
|
|
|
TODO
|
|
|
|
## 🗂️ Structure
|
|
|
|
TODO
|
|
|
|
## ⚙️ Fonctionnement
|
|
|
|
TODO
|
|
|
|
## ▶️ Usage
|
|
|
|
TODO
|
|
|
|
### Local watch mode
|
|
|
|
```sh
|
|
echo 'cohabit.localhost' >> /etc/hosts # In sudo, one time
|
|
mkcert -install # If mkcert is not installed in your root ca
|
|
mkcert -ecdsa localhost # Only once to issue localhost certificates
|
|
deno task start
|
|
```
|
|
|
|
### Production run
|
|
|
|
```sh
|
|
deno task build && deno task serve
|
|
```
|
|
|
|
## 🤝 Contributing
|
|
|
|
Any kind of contribution is welcomed. Please read
|
|
[contributing guidelines](./CONTRIBUTING.md) before and respect
|
|
[contributor covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
|
|
|
|
### For local development:
|
|
|
|
**Required dependencies**:
|
|
|
|
- [`deno`](https://deno.land) To run project (code, ci, ...).
|
|
- [`mkcert`](https://github.com/FiloSottile/mkcert) To get https self signed
|
|
certificate for localhost.
|
|
|
|
**Using VSCode**:
|
|
|
|
- Pre-configured workspace available in
|
|
[`gowest.code-workspace`](./gowest.code-workspace).
|
|
- Or without local tooling install use [`.devcontainer`](./.devcontainer).
|