{"id":17963234,"url":"https://github.com/kajdev/project-s","last_synced_at":"2025-08-18T16:04:49.135Z","repository":{"id":234120158,"uuid":"788304895","full_name":"KAJdev/project-s","owner":"KAJdev","description":"The most unique 4X game ever made. The final frontier, in your browser.","archived":false,"fork":false,"pushed_at":"2024-04-22T09:06:03.000Z","size":5778,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-22T12:59:56.543Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/KAJdev.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":"2024-04-18T06:53:15.000Z","updated_at":"2024-04-24T09:35:03.978Z","dependencies_parsed_at":"2024-04-24T09:34:58.130Z","dependency_job_id":"465d7999-810e-4af9-9279-3cf00f062480","html_url":"https://github.com/KAJdev/project-s","commit_stats":null,"previous_names":["kajdev/project-s"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/KAJdev/project-s","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KAJdev%2Fproject-s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KAJdev%2Fproject-s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KAJdev%2Fproject-s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KAJdev%2Fproject-s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KAJdev","download_url":"https://codeload.github.com/KAJdev/project-s/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KAJdev%2Fproject-s/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271019393,"owners_count":24685678,"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","status":"online","status_checked_at":"2025-08-18T02:00:08.743Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-10-29T11:24:57.893Z","updated_at":"2025-08-18T16:04:49.109Z","avatar_url":"https://github.com/KAJdev.png","language":"TypeScript","readme":"# Project S\n\n![project s screenshot](/splash.png)\n\n\u003e [!IMPORTANT]\n\u003e This project is in its infancy, so be a little patient with it. Please don't hesistate to open an issue if you find any bugs or want to suggest tweaks.\n\nA super duper original (totally revolutionary) space game inspired by games like Neptune's Pride. Created with next.js (zustand, tailwind, konva, framer-motion) on the frontend, python (asyncio, motor, beanie, sanic) on the backend, assuming MongoDB as a database.\n\n## Getting Started\n\nIf you'd like to contruibute, tweak, or run your own local instance of Project S for whatever reason. The structure is a monorepo with `frontend` and `backend` packages. Database not included.\n\n### Running the backend\n\n\u003e [!NOTE]\n\u003e Requires python 3.11 or higher\n\nNavigate to the `backend` directory\n\n```bash\ncd ./packages/backend\n```\n\nCreate `.env` with the following template\n\n\u003e [!IMPORTANT]\n\u003e You need a DB set up for this. Google is your friend and I am a lazy writer.\n\n```env\nMONGO_URL={database uri}\nDEBUG=1\nENV=staging\nOPENAI_TOKEN={open ai token if you want}\n```\n\nCreate a virtual environment (optional but recommended to keep your system packages clean, requires virtualenv)\n\n```bash\n# Windows\npy -m venv venv\n\n# *nix\npython3 -m venv venv\n```\n\nActivate the virtual environment\n\n```bash\n# Windows\n./venv/Scripts/activate\n\n# *nix\nsource ./venv/bin/activate\n```\n\nInstall dependencies\n\n```bash\npip install -r requirements.txt\n```\n\nStart the webserver\n\n```bash\npython3 main.py\n```\n\nCool! Now let's get the frontend running so we can start a game!\n\n### Running the frontend\n\n\u003e [!NOTE]\n\u003e Requires nodejs and npm or yarn or [insert trendy package manager]\n\nNavigate to the `frontend` directory\n\n```bash\ncd ./packages/frontend\n```\n\nCreate `.env.local` with the following template\n\n```env\nNEXT_PUBLIC_API_URL=http://localhost:8000\nNEXT_PUBLIC_GATEWAY_URL=ws://localhost:8000\n```\n\nInstall dependencies\n\n```bash\nnpm install\n# or\nyarn install\n# or whatever's hot right now\n```\n\nStart the dev webserver\n\n```bash\nnpm run dev\n# or\nyarn dev\n# ...\n```\n\nThat's it! You should see the localhost url in your terminal and should be able to play a local game of Project S!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkajdev%2Fproject-s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkajdev%2Fproject-s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkajdev%2Fproject-s/lists"}