joy - GitLite

KO | EN

gitlite — search

#javascript #react #typescript #llm #machine-learning #docker #awesome #awesome-list #vue #security #mcp #ios #openai #open-source

joy

(★ 611)

A full stack web framework written in janet

파일 탐색기

최종 버전 다운로드 (.zip)

- - main.yml
  - publish.yml
- FUNDING.yml
- docker-compose.nginx.yml
- docker-compose.traefik.yml
- docker-compose.yml
- Dockerfile
- nginx.conf
- _config.yml
- authentication.md
- database-migrations.md
- database-queries.md
- deployments.md
- form-submission.md
- form-validation.md
- html-rendering.md
- index.md
- introduction.md
- middleware.md
- readme.md
- requests-and-responses.md
- routing.md
- sessions.md
- tutorial.md
- test.css
- - cli.janet
  - csrf.janet
  - db.janet
  - env.janet
  - form-helper.janet
  - helper.janet
  - html.janet
  - http.janet
  - logger.janet
  - middleware.janet
  - responder.janet
  - router.janet
  - session.janet
  - validator.janet
- joy.janet
- - csrf-test.janet
  - form-helper-test.janet
  - helper-test.janet
  - html-test.janet
  - http-test.janet
  - logger-test.janet
  - responder-test.janet
  - router-test.janet
  - validator-test.janet
- joy-test.janet
.gitattributes
.gitignore
CHANGELOG.md
joy
LICENSE
project.janet
README.md
Vagrantfile

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/joy-framework/joy

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd joy

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose -f docker/docker-compose.nginx.yml up -d --build

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## You Found Joy!

Joy is a full stack web framework written in [janet](https://github.com/janet-lang/janet)

```clojure
(use joy)

(route :get "/" :home)
(defn home [request]
  (text/plain "You found joy!"))

(def app (app))

(server app 9001)
```

## Getting Started

First make sure [janet is installed](https://janet-lang.org/docs/index.html)

Next, install the joy cli like this

```sh
jpm install joy
```

Hopefully the `joy` executable will be on your path and ready to roll. If it isn't and you're like me and use homebrew, add this to your `.zprofile`:

```sh
export PATH=/usr/local/Cellar/janet/<your janet version here>/bin:$PATH
```

Then make sure you reload the profile:

```sh
source ~/.zprofile
```

Now, run the following from your terminal

```sh
joy new my-joy-project
```

This should create a new directory called `my-joy-project` and it should create a few files and things
to get you started.

### Taking it for a spin

Now that we have a project set up, it's time to test it out in the browser:

```sh
joy server
```

This should start an http server that's listening at http://localhost:9001.

Next, let's create a database, a table and connect it with routes and a few functions for handling requests.

### Create a new sqlite database

If you aren't already in the `my-joy-project` directory, go ahead and get in there. Now run

```sh
joy create db
```

This creates a new empty database named `dev.sqlite3`.

The default template doesn't assume you want a database so you'll need to connect to it in `main.janet`:

```clojure
; # main.janet

(defn main [& args]
  (db/connect (env :database-url))
  (server app (env :port))
  (db/disconnect))
```

### Create a database table

Run this to create a new migration with a table with a few columns:

```sh
joy create table account 'email text unique not null' 'password text not null'
```

This has created one file in your db/migrations folder that is waiting to get applied to the database.

### Run database migrations

Run this from your terminal

```sh
joy migrate
```

This will migrate your database and create a new file `db/schema.sql`

### Generate helpful routes

In joy there are no ORMs, no classes, and no objects, just functions that take requests and return responses.

Let's generate a few routes for the table from earlier:

```sh
joy create controller account
```

Those commands have created another new file: `routes/account.janet` and updated your `main.janet` file with an import statement so the account routes get set up.

Go ahead and check out the new `account` routes in the browser now: `http://localhost:9001/accounts`

Joy can do a lot more than that, [check out the docs here](https://github.com/joy-framework/joy/blob/master/docs/readme.md)

## Why?

I wanted something that felt like [coast](https://coast.swlkr.com) but took so little resources (memory + cpu) I could run dozens (if not hundreds) of websites on a cheap [VPS](https://www.vultr.com/?ref=7614094).

## Docker/Docker Compose

In order to make using joy more portable, we wanted to include a Dockerfile that creates an easy place for you to mount your code in and run joy without having to install anything or manage permissions on your local.