https://github.com/diamondlightsource/squid
A repo for UI library developments
https://github.com/diamondlightsource/squid
Last synced: 3 months ago
JSON representation
A repo for UI library developments
- Host: GitHub
- URL: https://github.com/diamondlightsource/squid
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2024-07-10T10:09:28.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-25T14:52:06.000Z (3 months ago)
- Last Synced: 2025-02-25T15:43:04.042Z (3 months ago)
- Language: TypeScript
- Size: 9.01 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Turborepo Docker starter
This is from an official Docker starter Turborepo.
To start a particular application go to its readme in `/apps/[app of interest]`.
## Apps and Packages
- `web`: a [Next.js](https://nextjs.org/) app
- `api`: an [Express](https://expressjs.com/) server
- `b18-csv-generator`: a config generator for a beamline
- `bluegui`: a test client for blueapi
- `TEMPLATE-nextjs-app`: a template for making NEXTjs apps
- `TEMPLATE-vite-app`: a template for making vite apps
- `test-next-safe-action`: a test of the next safe action setup
- `trpc-test`: a test of trpc (next safe action won)
- `@repo/ui`: a React component library
- `@repo/logger`: Isomorphic logger (a small wrapper around console.log)
- `@repo/eslint-config`: ESLint presets
- `@repo/typescript-config`: tsconfig.json's used throughout the monorepo
- `@repo/jest-presets`: Jest configurations
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Docker
This repo is configured to be built with Docker, and Docker compose. To build all apps in this repo:
```
# Create a network, which allows containers to communicate
# with each other, by using their container name as a hostname
docker network create app_network
# Build prod using new BuildKit engine
COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -f docker-compose.yml build
# Start prod in detached mode
docker-compose -f docker-compose.yml up -d
```
Open http://localhost:3000.
To shutdown all running containers:
```
# Stop all running containers
docker kill $(docker ps -q) && docker rm $(docker ps -a -q)
```
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Jest](https://jestjs.io) test runner for all things JavaScript
- [Prettier](https://prettier.io) for code formatting