Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wralith/paiwr
Study Date?
https://github.com/wralith/paiwr
go solidjs typescript
Last synced: about 2 months ago
JSON representation
Study Date?
- Host: GitHub
- URL: https://github.com/wralith/paiwr
- Owner: wralith
- License: mit
- Created: 2023-04-15T02:00:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-04T16:57:26.000Z (over 1 year ago)
- Last Synced: 2024-06-19T14:50:17.142Z (7 months ago)
- Topics: go, solidjs, typescript
- Language: Go
- Homepage:
- Size: 359 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Paiwr
What it does? Nothing, but hopefully it will get you few study dates? In theory?
## Setup For Development
#### With Docker Compose
```bash
docker compose up
```
_You might have to `cd client && pnpm install` until I fix `node_modules` related problems in docker-compose._
#### Without
```bash
# Client
cd client
pnpm install # Ofc you can use npm or yarn as well
pnpm dev
# Server
cd server
go run . # DB_CONN_STR and JWT_SECRET environment variables are required
# Postgres Database with Docker
docker run --name postgres-paiwr -d -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=secret postgres:alpine
```
_You can use [`gow`](https://github.com/mitranim/gow) to watch `go` files and rerun `go run` when something changed, similar to `nodemon`._
## Stack
- Server written in `Go` with bunch of libraries: [`Fiber`](https://github.com/gofiber/fiber), [`pgx`](https://github.com/jackc/pgx), [`Squirrel`](https://github.com/Masterminds/squirrel) etc.
- Client written in [Solid](https://github.com/solidjs/solid) with [`Tailwind`](https://tailwindcss.com/), _you can clone clean template with eslint-prettier configured from [Here](https://github.com/wralith/solid-ts-tailwind)_
## Endpoints
```
server default :: http://localhost:8080
client default :: http://localhost:3000
/metrics Prometheus metrics
/swagger or /docs API docs (Swagger UI and Rapidoc)
/monitor Fiber Monitor
/users User stuff...
/topics Topic stuff...
/... Client App
```
## Todo
Lots of stuff...