Skip to content

Commit

Permalink
chore: setup project using fresh and twind
Browse files Browse the repository at this point in the history
The project was scaffoled using `deno run -A -r https://fresh.deno.dev your-project-name`

BREAKING CHANGE: drop out development using nuxt3 and openprops in favour deno web framework

fix #38
  • Loading branch information
binodnepali committed Apr 22, 2023
1 parent f054bb8 commit 1b73068
Show file tree
Hide file tree
Showing 53 changed files with 308 additions and 12,846 deletions.
14 changes: 0 additions & 14 deletions .eslintrc.js

This file was deleted.

5 changes: 0 additions & 5 deletions .firebaserc

This file was deleted.

13 changes: 2 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,2 @@
#dependencies
node_modules
.yarn

*.log
.nuxt
nuxt.d.ts
.output
.env
.firebase
.DS_Store
#misc
.DS_Store
4 changes: 0 additions & 4 deletions .husky/commit-msg

This file was deleted.

4 changes: 0 additions & 4 deletions .husky/pre-commit

This file was deleted.

36 changes: 0 additions & 36 deletions .prettierignore

This file was deleted.

5 changes: 0 additions & 5 deletions .prettierrc

This file was deleted.

6 changes: 6 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"recommendations": [
"denoland.vscode-deno",
"sastan.twind-intellisense"
]
}
8 changes: 3 additions & 5 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"cssvar.files": [
"./node_modules/open-props/open-props.min.css",
"./styles/global.css"
],
"cssvar.extensions": ["css", "vue", "sass", "scss"]
"deno.enable": true,
"deno.lint": true,
"editor.defaultFormatter": "denoland.vscode-deno"
}
1 change: 0 additions & 1 deletion .yarnrc.yml

This file was deleted.

28 changes: 0 additions & 28 deletions CHANGELOG.md

This file was deleted.

155 changes: 11 additions & 144 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,13 @@

[![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 [Nuxt 3](https://v3.nuxtjs.org/) and [OpenProps](https://open-props.style/). And It also makes use of [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) & [SCSS/SASS](https://sass-lang.com/) for styling website.
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/).

## Before getting started

Make sure you have installed [Node.js 16.11.0 or higher](https://nodejs.org/en/) on your machine. You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple node version on your machine.
Make sure you have installed [deno 1.32.5](https://deno.land/[email protected]/introduction) in your machine.

## Getting started

You can setup this project using npm or yarn package managers.

> I would recommend to installed or enabled [yarn 3.1.1 or higher](https://yarnpkg.com/getting-started) package manager on your machine.
### Clone repo
### Cloning repo

```bash
# https
Expand All @@ -30,145 +24,18 @@ git clone [email protected]:binodnepali/portfolio.git
cd portfolio
```

## Setup

### Install app dependencies

```bash
# npm
npm install

# yarn
yarn install
```

### Run app in development

```bash
# npm
npm run dev

# yarn
yarn dev
```

> Start development server on <http://localhost:3000>
### Build app for production

```bash
# npm
npm run build

# yarn
yarn build
```

### Preview for production

```bash
# npm
npm run start

# yarn
yarn start
```

> Start preview server on <http://localhost:3000>
### Lint
### Usage

```bash
# yarn
yarn lint
Start the project:

# npm
npm run lint
```

### Lint fix

```bash
# yarn
yarn lint:fix

# npm
npm run lint:fix
deno task start
```

### Lint style

```bash
# yarn
yarn lint:style

# npm
npm run lint:style
```

### Lint style fix

```bash
# yarn
yarn lint:style:fix

# npm
npm run lint:style:fix
```

### Commit

Open interactive terminal to write conventional commit message

```bash
# yarn
yarn commit

# npm
npm run commit
```

### First release

Create a first release tag and generates change log based on commit history

```bash
# yarn
yarn release:first

# npm
npm run release:first
```

### Release

Create a release tag and generates change log based on commit history

```bash
# yarn
yarn release

# npm
npm run release
```

### Deploy to firebase hosting

```bash
# npm
npm run deploy:firebase

# yarn
yarn deploy:firebase
```
This will watch the project directory and restart as necessary.

### Reference
### Available routes

* Prettier - [Learn more](https://prettier.io/)
* ESLint - [Learn more](https://eslint.org/)
* Stylelint - [Learn more](https://stylelint.io/)
* Lint staged - [Learn more](https://github.com/okonet/lint-staged)
* Commitlint - [Learn more](https://commitlint.js.org/#/)
* Commitizen - [Learn more](https://commitizen.github.io/cz-cli/)
* Deployment in firebase hosting - [Learn more](https://nitro.unjs.io/deploy/providers/firebase)
>Recommend to install `npm install -g [email protected]`
1. http://localhost:8000/ - home page
2. http://localhost:8000/YOUR-NAME - dynamic page example
3. http://localhost:8000/api/intro - api route example
1 change: 0 additions & 1 deletion assets/darkMode.svg

This file was deleted.

1 change: 0 additions & 1 deletion assets/github.svg

This file was deleted.

1 change: 0 additions & 1 deletion assets/lightMode.svg

This file was deleted.

1 change: 0 additions & 1 deletion assets/linkedin.svg

This file was deleted.

1 change: 0 additions & 1 deletion commitlint.config.js

This file was deleted.

12 changes: 12 additions & 0 deletions components/Button.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { JSX } from "preact";
import { IS_BROWSER } from "$fresh/runtime.ts";

export function Button(props: JSX.HTMLAttributes<HTMLButtonElement>) {
return (
<button
{...props}
disabled={!IS_BROWSER || props.disabled}
class="px-2 py-1 border(gray-100 2) hover:bg-gray-200"
/>
);
}
36 changes: 0 additions & 36 deletions components/MyBio/MyBio.vue

This file was deleted.

Loading

0 comments on commit 1b73068

Please sign in to comment.