{"id":16137726,"url":"https://github.com/joosepalviste/serieslist","last_synced_at":"2025-03-16T09:33:11.477Z","repository":{"id":42619862,"uuid":"92652386","full_name":"JoosepAlviste/serieslist","owner":"JoosepAlviste","description":"Always know which episode to watch next. Keep track of your series and seen episodes.","archived":false,"fork":false,"pushed_at":"2024-04-29T08:49:39.000Z","size":5311,"stargazers_count":6,"open_issues_count":23,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-07T21:46:59.787Z","etag":null,"topics":["kysely","nodejs","pothos","radix-ui","react","tv-series","typescript","vite-plugin-ssr"],"latest_commit_sha":null,"homepage":"https://serieslist.joosep.xyz","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JoosepAlviste.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-05-28T09:42:33.000Z","updated_at":"2024-04-29T01:58:51.000Z","dependencies_parsed_at":"2024-02-16T22:26:43.579Z","dependency_job_id":"3e83d71c-6e26-4069-a2a5-7e5a2ddb586a","html_url":"https://github.com/JoosepAlviste/serieslist","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoosepAlviste%2Fserieslist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoosepAlviste%2Fserieslist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoosepAlviste%2Fserieslist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoosepAlviste%2Fserieslist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoosepAlviste","download_url":"https://codeload.github.com/JoosepAlviste/serieslist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809844,"owners_count":20351406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kysely","nodejs","pothos","radix-ui","react","tv-series","typescript","vite-plugin-ssr"],"created_at":"2024-10-09T23:29:05.467Z","updated_at":"2025-03-16T09:33:11.062Z","avatar_url":"https://github.com/JoosepAlviste.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serieslist\n\nKeep track of your series and seen episodes.\n\nThe series are automatically imported from [The Movie Database (TMDB)](https://www.themoviedb.org/).\n\n![Screenshot of Serieslist](https://github.com/JoosepAlviste/serieslist/assets/9450943/28e12199-4d9c-4e05-8c9b-3648e4e7f482)\n\n\n## Tech stack\n\nThe goal of the tech stack is to be as fully statically typed as possible, all \nthe way from the database to the front-end, while being as simple as possible. \n[`pnpm`](https://pnpm.io/) and [`nx`](https://nx.dev/) are used to manage the \nmultiple workspaces.\n\nThe front-end is an SPA with server-side rendering:\n\n- [React](https://react.dev/)\n- [Vite](https://vitejs.dev/), [`vite-plugin-ssr`](https://vite-plugin-ssr.com/)\n- [Apollo Client](https://www.apollographql.com/docs/react/)\n- [Radix UI](https://www.radix-ui.com/)\n- [Vanilla Extract](https://vanilla-extract.style/)\n- [React Hook Form](https://react-hook-form.com/)\n- [GraphQL Code Generator](https://the-guild.dev/graphql/codegen)\n- [Vitest](https://vitest.dev/), [React Testing Library](https://testing-library.com/docs/react-testing-library/)\n\nThe back-end is a GraphQL API with full type safety:\n\n- [Node](https://nodejs.org/)\n- [Fastify](https://www.fastify.io/), [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server), [Pothos GraphQL](https://pothos-graphql.dev/)\n- [Drizzle ORM](https://orm.drizzle.team/)\n- [PostgreSQL](https://www.postgresql.org/)\n\nAnd of course, all code is checked with:\n\n- [TypeScript](https://www.typescriptlang.org/)\n- [ESLint](https://eslint.org/)\n- [Prettier](prettier.io/)\n\nFinally, the project is continuously deployed to a \n[DigitalOcean](digitalocean.com/) droplet with the help of:\n\n- [Docker](https://www.docker.com/)\n- [GitHub Actions](https://github.com/features/actions)\n- [Caddy](https://caddyserver.com/)\n\n\n## Set up\n\n### Requirements\n\n- [Node.js](https://nodejs.org/)\n- [`pnpm`](https://pnpm.io/)\n- See the required versions in [`package.json`](package.json), `engines` field\n\n```bash\ngit clone https://github.com/JoosepAlviste/serieslist.git\n\npnpm install\n./bin/generate-secret-token.sh\n```\n\nNext, [generate a new TMDB API token](https://www.themoviedb.org/settings/api) \nand add it into the [`.env`](.env) file. Make sure to check the rest of the \n`.env` file for any other variables that should be updated.\n\n### Run the project in development mode\n\nFirst, run the Redis and database containers and migrate the database:\n\n```sh\ndocker-compose up -d\npnpm migrate\n# Migrate the test database\npnpm migrate:test\n```\n\nThen, run the application (both the API and the web application):\n\n```sh\npnpm start\n```\n\nFor more specific information about the webapp and the API, check out their \nrespective READMEs.\n\nThe development server is accessible at http://localhost:3000.\n\n\n### File structure\n\nBoth the API and the webapp follow a similar file structure where the folders \nare split into features. The `src` folders contain some general, \"global\" files, \nwhile the `src/features` folders contain feature-specific code.\n\n\n#### Packages\n\nThese are the types of packages in the [`packages`](packages) folder:\n\n- `core-`: Packages that provide reusable logic to be used in all other packages\n- `feature-`: Packages containing business logic\n- `util-`: Utilities and pure functions that don't usually have any \n  framework-specific code\n\n\n### Generating a new package\n\nA new package can be generated with:\n\n```sh\npnpm generate:package\n```\n\n\n## Production\n\nThe project is deployed to a DigitalOcean droplet and is continuously deployed \nwith GitHub Actions whenever anything is merged to `master`.\n\nIn production, the API and the webapp are run inside Docker like so:\n\n```sh\ndocker-compose -f docker-compose.production.yml up\n```\n\n[Neon](https://neon.tech) is used as a managed PostgreSQL service.\n\nThe pipeline builds Docker images, pushes them to the GitHub registry, SSH-es \ninto the server, and pulls the images.\n\n### Sentry\n\nError monitoring in Sentry requires setting up a few environment variables:\n\n- `API_SENTRY_DSN`: The API project DSN\n- `VITE_APP_SENTRY_DSN`: The webapp project DSN\n- `SENTRY_ORG`\n- `SENTRY_PROJECT`\n- `SENTRY_AUTH_TOKEN`: Generate from \n  https://sentry.io/settings/account/api/auth-tokens/, requires the \n  `project:releases` and `org:read` scopes\n\n\n## E2E tests\n\nThere are some end-to-end tests, but they are still a work in progress.\n\nFirst, migrate the test database:\n\n```sh\npnpm migrate:test\n```\n\nThen, run the e2e tests:\n\n```sh\n# Install the playwright dependencies if they haven't been yet\n(cd apps/e2e \u0026\u0026 pnpm dlx playwright install chromium --with-deps)\npnpm test:e2e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoosepalviste%2Fserieslist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoosepalviste%2Fserieslist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoosepalviste%2Fserieslist/lists"}