nzambello/translaite
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: add readme info

Browse source
This commit is contained in:
Nicola Zambello 2023-08-07 13:42:58 +02:00
parent 0f735d2efb
commit f0f878a122
Signed by: nzambello
GPG key ID: 56E4A92C2C1E50BA
1 changed files with 113 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

252
README.md
View file

@ -1,174 +1,132 @@
# Remix Indie Stack # translAIte
![The Remix Indie Stack](https://repository-images.githubusercontent.com/465928257/a241fa49-bd4d-485a-a2a5-5cb8e4ee0abf) Translations app built with Remix, supports authentication. Uses ChatGPT to translate text.
Learn more about [Remix Stacks](https://remix.run/stacks). After your first login, you will be prompted to enter your OpenAI API key. You can get one [here](https://platform.openai.com/account/api-keys).
```sh Built for self-hosting: host it anywhere you want, and use it for free.
npx create-remix@latest --template remix-run/indie-stack
View on [DockerHub](https://hub.docker.com/r/nzambello/translaite).
## Table of contents
- [Pre-built Docker image](#pre-built-docker-image)
- [Docker compose](#docker-compose)
- [Custom deployments or development](#custom-deployment-or-development)
- [Tech stack](#tech-stack)
- [Running locally](#running-locally)
- [Running with Docker](#running-with-docker)
- [Multi-platform docker image](#multi-platform-docker-image)
- [License](#license)
## Pre-built Docker Image
```bash
docker pull nzambello/translaite
``` ```
## What's in the stack If you want to use the pre-built Docker image, you can run it with:
- [Fly app deployment](https://fly.io) with [Docker](https://www.docker.com/) ```bash
- Production-ready [SQLite Database](https://sqlite.org) docker run -d -p 8080:8080 -v /path/to/data:/data/data.db nzambello/translaite
- Healthcheck endpoint for [Fly backups region fallbacks](https://fly.io/docs/reference/configuration/#services-http_checks)
- [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments
- Email/Password Authentication with [cookie-based sessions](https://remix.run/utils/sessions#md-createcookiesessionstorage)
- Database ORM with [Prisma](https://prisma.io)
- Styling with [Tailwind](https://tailwindcss.com/)
- End-to-end testing with [Cypress](https://cypress.io)
- Local third party request mocking with [MSW](https://mswjs.io)
- Unit testing with [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com)
- Code formatting with [Prettier](https://prettier.io)
- Linting with [ESLint](https://eslint.org)
- Static Types with [TypeScript](https://typescriptlang.org)
Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --template your/repo`! Make it your own.
## Quickstart
Click this button to create a [Gitpod](https://gitpod.io) workspace with the project set up and Fly pre-installed
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/remix-run/indie-stack/tree/main)
## Development
- Initial setup:
```sh
npm run setup
``` ```
- Start dev server: If you want to use different defaults, you can build your own image. See [Running with docker](#running-with-docker)
```sh ### Docker compose
npm run dev
Basic example:
```yaml
version: "3.8"
services:
translaite:
image: nzambello/translaite
container_name: translaite
restart: always
ports:
- 8080:8080
volumes:
- ./dockerData/translaite:/data # Path to data for DB persistence
``` ```
This starts your app in development mode, rebuilding assets on file changes. Example of docker-compose.yml with [Traefik](https://traefik.io/) as reverse proxy:
The database seed script creates a new user with some data you can use to get started: ```yaml
translaite:
- Email: `rachel@remix.run` depends_on:
- Password: `racheliscool` - watchtower
image: nzambello/translaite
### Relevant code: container_name: translaite
restart: always
This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes. volumes:
- /dockerData/translaite:/data # Path to data for DB persistence
- creating users, and logging in and out [./app/models/user.server.ts](./app/models/user.server.ts) labels:
- user sessions, and verifying them [./app/session.server.ts](./app/session.server.ts) - "com.centurylinklabs.watchtower.enable=true"
- creating, and deleting notes [./app/models/note.server.ts](./app/models/note.server.ts) - "traefik.enable=true"
- "traefik.http.routers.translaite.rule=Host(`translate.YOURDOMAIN.com`)" # change it to your preferences
## Deployment - "traefik.http.routers.translaite.entrypoints=websecure"
- "traefik.http.routers.translaite.tls.certresolver=letsencrypt"
This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments. - "traefik.http.routers.translaite.service=translaite-service"
- "traefik.http.services.translaite-service.loadbalancer.server.port=8080"
Prior to your first deployment, you'll need to do a few things:
- [Install Fly](https://fly.io/docs/getting-started/installing-flyctl/)
- Sign up and log in to Fly
```sh
fly auth signup
``` ```
> **Note:** If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run `fly auth whoami` and ensure the email matches the Fly account signed into the browser. ## Custom deployment or development
- Create two apps on Fly, one for staging and one for production: ### Tech Stack
```sh - [Remix](https://remix.run)
fly apps create translaite-2ae4 - [Prisma](https://prisma.io)
fly apps create translaite-2ae4-staging - [SQLite](https://sqlite.org)
- [Tailwind](https://tailwindcss.com)
- [Docker](https://docker.com)
### Running Locally
```bash
# Clone the repo
git clone https://github.com/nzambello/translaite.git
cd translaite
# Install dependencies
yarn install
# Setup .env
cp .env.example .env
vim .env
# Start the app
yarn dev
``` ```
> **Note:** Make sure this name matches the `app` set in your `fly.toml` file. Otherwise, you will not be able to deploy. ### Running with Docker
- Initialize Git. ```bash
# Clone the repo
git clone https://github.com/nzambello/translaite.git
cd translaite
```sh # Setup .env
git init cp .env.example .env
vim .env
# Build the image
docker built -t translaite .
# Start the app
docker run -p 127.0.0.1:8080:8080 translaite
``` ```
- Create a new [GitHub Repository](https://repo.new), and then add it as the remote for your project. **Do not push your app yet!** ### Multi-platform Docker image
```sh ```bash
git remote add origin <ORIGIN_URL> docker buildx create --name mybuilder --driver docker-container --bootstrap --use # create a new builder and switch to it using a single command.
docker buildx build --platform linux/amd64,linux/arm64 -t nzambello/translaite:latest --push .
``` ```
- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`. ## License
- Add a `SESSION_SECRET` to your fly app secrets, to do this you can run the following commands: [Nicola Zambello](https://github.com/nzambello) © 2023
```sh [GNU GPLv3](https://github.com/nzambello/translaite/raw/main/LICENSE)
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app translaite-2ae4
fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app translaite-2ae4-staging
```
If you don't have openssl installed, you can also use [1Password](https://1password.com/password-generator) to generate a random secret, just replace `$(openssl rand -hex 32)` with the generated secret.
- Create a persistent volume for the sqlite database for both your staging and production environments. Run the following:
```sh
fly volumes create data --size 1 --app translaite-2ae4
fly volumes create data --size 1 --app translaite-2ae4-staging
```
Now that everything is set up you can commit and push your changes to your repo. Every commit to your `main` branch will trigger a deployment to your production environment, and every commit to your `dev` branch will trigger a deployment to your staging environment.
### Connecting to your database
The sqlite database lives at `/data/sqlite.db` in your deployed application. You can connect to the live database by running `fly ssh console -C database-cli`.
### Getting Help with Deployment
If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to [the Fly support community](https://community.fly.io). They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions.
## GitHub Actions
We use GitHub Actions for continuous integration and deployment. Anything that gets into the `main` branch will be deployed to production after running tests/build/etc. Anything in the `dev` branch will be deployed to staging.
## Testing
### Cypress
We use Cypress for our End-to-End tests in this project. You'll find those in the `cypress` directory. As you make changes, add to an existing file or create a new file in the `cypress/e2e` directory to test your changes.
We use [`@testing-library/cypress`](https://testing-library.com/cypress) for selecting elements on the page semantically.
To run these tests in development, run `npm run test:e2e:dev` which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.
We have a utility for testing authenticated features without having to go through the login flow:
```ts
cy.login();
// you are now logged in as a new user
```
We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:
```ts
afterEach(() => {
cy.cleanupUser();
});
```
That way, we can keep your local db clean and keep your tests isolated from one another.
### Vitest
For lower level tests of utilities and individual components, we use `vitest`. We have DOM-specific assertion helpers via [`@testing-library/jest-dom`](https://testing-library.com/jest-dom).
### Type Checking
This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run `npm run typecheck`.
### Linting
This project uses ESLint for linting. That is configured in `.eslintrc.js`.
### Formatting
We use [Prettier](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project.