An open API service indexing awesome lists of open source software.

https://github.com/nyaomaru/nyaomaru-base

Nyaomaru site base repository
https://github.com/nyaomaru/nyaomaru-base

nextjs nextjs-example nextjs-template nextjs-typescript nextjs-typescript-tailwindcss template-project typescript

Last synced: about 1 month ago
JSON representation

Nyaomaru site base repository

Awesome Lists containing this project

README

          

# nyaomaru_base

This repositry is my business base template.

Feel free to use it.

## Purpose

By showing my private repository to public, I have got to enhance the coding quality.

And raise my motivation for maintenance of code.

## Get started 🚀

First, you run git clone.

```sh
git clone git@github.com:nyaomaru/nyaomaru_base.git
```

If you use docker, you can run `docker compose up -d` in the working directory.

```sh
docker compose up -d
```

If you don't use docker, you need to run below command.

```sh
pnpm i
pnpm dev
```

Then, you access to [`localhost:3333/top`](http://localhost:3333/top/), you can see the website.

### storybook

you can use storybook.

If you don't use docker, you need to run below command.

```sh
pnpm storybook
```

Then, you access to [`localhost:6006/`](http://localhost:6006/), you can see nyaomaru base storybook.

### jest

[![Jest](https://skillicons.dev/icons?i=jest)](https://skillicons.dev)

you can run jest tests.

If you want to run jest, you run below code.

```sh
pnpm test
```