Readme and Deno.json Update.

This commit is contained in:
Esad Mustafoski
2024-10-31 14:18:27 +01:00
parent b8c12ccc79
commit a1318e7397
2 changed files with 40 additions and 5 deletions

View File

@@ -3,20 +3,53 @@
---
## What's this?
ESP is a simple social media platform built with Deno, Vite and Typescript.
ESP is a simple social media platform built with [Deno](https://deno.land/), [Vite](https://vitejs.dev/) and [Typescript](https://www.typescriptlang.org/).
## But there's lots of Social Media, why another one?
We're building ESP to avoid the clutter of other Social Media websites.
It's build to be simple, fast and easy to use, all while keeping a Minimal feeling to it.
---
# How do I run it?
## Running
Dev server:
```
```bash
$ deno task dev
```
## Deploy
Build production assets:
```
```bash
$ deno task build
```
---
---
# Resources
## Libs/Frameworks used
<ul>
<li><a href="https://deno.land/"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Deno.svg/600px-Deno.svg.png" width="20" height="20"> Deno</a></li>
<li><a href="https://vitejs.dev/"><img src="https://vitejs.dev/logo.svg" width="20" height="20"> Vite</a></li>
<li><a href="https://www.typescriptlang.org/"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/4c/Typescript_logo_2020.svg/512px-Typescript_logo_2020.svg.png?20221110153201" width="20" height="20"> TypeScript</a></li>
<li><a href="https://oakserver.github.io/oak/"><img src="https://oakserver.org/oak_logo.svg?__frsh_c=2e345d91800d1e0a52aa35efcaab769fa1768888" width="20" height="20"> Oak</a></li>
<li><a href="https://deno.land/x/denodb"><img src="https://github.com/eveningkid/denodb/blob/master/design/logo.png?raw=true" width="20" height="20"> DenoDB</a></li>
</ul>
## Tools used
<ul>
<li><a href="https://www.jetbrains.com/webstorm/"><img src="https://upload.wikimedia.org/wikipedia/commons/c/c0/WebStorm_Icon.svg" width="20" height="20"> JetBrains WebStorm</a></li>
<li><a href="https://neovim.io/"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/07/Neovim-mark-flat.svg/640px-Neovim-mark-flat.svg.png" width="20" height="20"> Neovim</a></li>
</ul>

View File

@@ -1,6 +1,8 @@
{
"tasks": {
"dev": "deno run -A --node-modules-dir npm:vite",
"dev": "deno task dev:api & deno task dev:vite",
"dev:api": "deno run --allow-env --allow-net api/main.ts",
"dev:vite": "deno run -A npm:vite",
"build": "deno run -A --node-modules-dir npm:vite build",
"preview": "deno run -A --node-modules-dir npm:vite preview",
"serve": "deno run --allow-net --allow-read jsr:@std/http@1/file-server dist/"