Skip to content

Commit

Permalink
docs: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
binodnepali committed Apr 29, 2024
1 parent db84805 commit 9f8b1ac
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 23 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
node_modules

#misc
.DS_Store
.DS_Store
# Fresh build directory
_fresh/
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

My [portfolio website](https://binodnepali.me/) build using [fresh](https://fresh.deno.dev/) a full stack framework for [deno](https://deno.land/) and [Twind](https://twind.dev/) a solution for js in [tailwind](https://tailwindcss.com/).
My [portfolio website](https://binodnepali.me/) build using
[fresh](https://fresh.deno.dev/) a full stack framework for
[deno](https://deno.land/) and [Tailwindcss](https://tailwindcss.com/).

This site is deployed using [deno deploy](https://docs.deno.com/deploy/manual).

## Before getting started

Make sure you have installed [deno 1.32.5](https://deno.land/manual@v1.32.5/introduction) in your machine.
Make sure you have installed [deno 1.39.1](https://docs.deno.com/runtime/manual)
or higher in your machine.

### Cloning repo

Expand All @@ -28,14 +33,26 @@ cd portfolio

Start the project:

```
```bash
deno task start
```

This will watch the project directory and restart as necessary.

### Available routes
Build the project

```bash
deno task build
```

Preview the project

1. http://localhost:8000/ - home page
2. http://localhost:8000/YOUR-NAME - dynamic page example
3. http://localhost:8000/api/intro - api route example
```bash
deno task preview
```

Update the project

```bash
deno task update
```
18 changes: 3 additions & 15 deletions deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,8 @@
"preview": "deno run -A main.ts",
"update": "deno run -A -r https://fresh.deno.dev/update ."
},
"lint": {
"rules": {
"tags": [
"fresh",
"recommended"
]
}
},
"exclude": [
"**/_fresh/*"
],
"lint": { "rules": { "tags": ["fresh", "recommended"] } },
"exclude": ["**/_fresh/*"],
"imports": {
"$fresh/": "https://deno.land/x/fresh@1.6.8/",
"preact": "https://esm.sh/preact@10.19.6",
Expand All @@ -31,9 +22,6 @@
"tailwindcss/plugin": "npm:/tailwindcss@3.4.1/plugin.js",
"$std/": "https://deno.land/std@0.216.0/"
},
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "preact"
},
"compilerOptions": { "jsx": "react-jsx", "jsxImportSource": "preact" },
"nodeModulesDir": true
}

0 comments on commit 9f8b1ac

Please sign in to comment.