{"id":25939023,"url":"https://github.com/shinolabs/PinkSea","last_synced_at":"2025-03-04T04:01:35.765Z","repository":{"id":260640104,"uuid":"879075928","full_name":"shinolabs/PinkSea","owner":"shinolabs","description":"An oekaki BBS board running on top of the AT Protocol.","archived":false,"fork":false,"pushed_at":"2025-02-09T13:18:17.000Z","size":7323,"stargazers_count":61,"open_issues_count":7,"forks_count":13,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-23T08:09:21.228Z","etag":null,"topics":["atproto","atprotocol","bluesky","decentralized","oekaki"],"latest_commit_sha":null,"homepage":"","language":"C#","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/shinolabs.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,"publiccode":null,"codemeta":null}},"created_at":"2024-10-26T22:44:36.000Z","updated_at":"2025-02-12T22:13:40.000Z","dependencies_parsed_at":"2024-11-16T10:21:10.994Z","dependency_job_id":"a04e4239-bd11-490f-8261-4c5bfa882288","html_url":"https://github.com/shinolabs/PinkSea","commit_stats":{"total_commits":135,"total_committers":11,"mean_commits":"12.272727272727273","dds":"0.12592592592592589","last_synced_commit":"d062a2c4872e7641acbfd78f7547343df659ff91"},"previous_names":["shinolabs/pinksea"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinolabs%2FPinkSea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinolabs%2FPinkSea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinolabs%2FPinkSea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinolabs%2FPinkSea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinolabs","download_url":"https://codeload.github.com/shinolabs/PinkSea/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241482104,"owners_count":19969849,"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":["atproto","atprotocol","bluesky","decentralized","oekaki"],"created_at":"2025-03-04T04:01:35.018Z","updated_at":"2025-03-04T04:01:35.749Z","avatar_url":"https://github.com/shinolabs.png","language":"C#","funding_links":[],"categories":["C# #"],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n\t\u003cimg width=\"200\" src=\"Meta/logo.svg\"\u003e\u003cbr\u003e\n\t\u003cb\u003ePinkSea\u003c/b\u003e\u003cbr\u003e\n\t\u003cspan\u003eponiko's house\u003c/span\u003e\u003cbr\u003e\n\t\u003ca href=\"https://weblate.shinolabs.com/projects/pinksea/frontend/\"\u003e\u003cimg src=\"https://weblate.shinolabs.com/widget/pinksea/frontend/svg-badge.svg\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n![An image of PinkSea's frontend displaying an oekaki post.](Meta/screenshot.png)\n\nAn oekaki BBS running as an [AT Protocol AppView](https://atproto.com/guides/glossary#app-view).\n\n# Running\n\n## Backend (AppView)\n\nIn order to run the AppView, you need the [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) and the Entity Framework tools package, which you can install through `dotnet tools -g install dotnet-ef`.\n\n### First-time run\n\n1. Run `docker compose up -d` inside of the root folder to start PostgreSQL (if you do not have PostgreSQL installed yet.)\n2. Open the `PinkSea` folder\n3. Copy the sample `appsettings.example.json` file to `appsettings.json`\n\t\n\t1. Modify the `PostgresConfig` to point to your PostgreSQL settings. If you're using the supplied docker compose, you do not need to change this.\n\t2. Point the `AppViewConfig` URL to where your AppView will reside, this is the URL that will be used to identify your PinkSea instance. (As an example, for the official PinkSea instance, it's `https://api.pinksea.art`)\n\t3. (OPTIONAL) Point the `FrontendConfig` to point to where your PinkSea frontend resides. This is used for BlueSky cross-posting with a link. Leaving it blank will disallow cross-posting. (Again, as an example, for the official PinkSea instance it's `https://pinksea.art`)\n\n4. Perform `dotnet ef database update` to run the neccessary migrations.\n5. Run `dotnet run --configuration Release` to start the PinkSea AppView.\n\nThat's it! Your server now is connected to the ATmosphere and is ready to start cooperating with other PinkSea AppViews.\n\n### Updating\n\n1. Navigate to the `PinkSea` folder.\n2. Run `dotnet ef database update` to run the migrations.\n3. Once again, run `dotnet run --configuration Release` to start the server in Release mode.\n\n## Frontend (Client app)\n\nIn order to run the client app locally, you need a fairly modern [Node.js](https://nodejs.org/en) version. Anything above Node 20 works, but I personally recommend the latest LTS version.\n\n### Configuration\n\n1. Navigate to `PinkSea.Frontend`.\n2. Run `npm i` to download the required packages.\n3. Navigate to the `src/api/atproto` folder.\n3. Point the `serviceEndpoint` value inside of `client.ts` to your AppView instance. (For example, for the official PinkSea instance, the endpoint is `https://api.pinksea.art`)\n\n### Running a local server\n\n1. Navigate to `PinkSea.Frontend`\n2. Run `npm i` to update the packages.\n3. Finally, execute `npm run dev`, to start a local development server with code reloading.\n\n### Building\n\n1. Navigate to `PinkSea.Frontend`\n2. Run `npm i` to update the packages.\n3. Finally, execute `npm run build`, to build and minify the client app.\n\nThe built app will be inside of the `dist` folder.\n\n# Acknowledgments\n\nThis is a list of people I'd love to extend my most sincere gratitude to!!\n\n* [GlitchyPSI](https://bsky.app/profile/glitchypsi.xyz) for drawing the \"post is missing\" image visible whenever we see a post that does not exist! Thank you so much!!!\n\n# License\n\nThe PinkSea code (with the exception of PinkSea.AtProto and PinkSea.AtProto.Server) is licensed under the European Union Public License-1.2. PinkSea.AtProto is released into the public domain as specified by the Unlicense. The appropriate licenses are in each folder's LICENSE files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinolabs%2FPinkSea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinolabs%2FPinkSea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinolabs%2FPinkSea/lists"}