{"id":22522258,"url":"https://github.com/webaverse/api-backend","last_synced_at":"2025-08-03T20:31:54.378Z","repository":{"id":43081183,"uuid":"202954845","full_name":"webaverse/api-backend","owner":"webaverse","description":"Node server hosted on AWS, mainly used for REST endpoints.","archived":false,"fork":false,"pushed_at":"2022-10-25T00:50:25.000Z","size":2205,"stargazers_count":9,"open_issues_count":9,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-31T15:37:14.083Z","etag":null,"topics":["backend","exokit","http","node","rest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webaverse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-18T03:21:27.000Z","updated_at":"2023-04-20T22:39:12.000Z","dependencies_parsed_at":"2023-01-20T03:20:04.628Z","dependency_job_id":null,"html_url":"https://github.com/webaverse/api-backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webaverse%2Fapi-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webaverse%2Fapi-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webaverse%2Fapi-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webaverse%2Fapi-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webaverse","download_url":"https://codeload.github.com/webaverse/api-backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228562273,"owners_count":17937234,"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":["backend","exokit","http","node","rest"],"created_at":"2024-12-07T05:14:50.125Z","updated_at":"2024-12-07T05:14:50.803Z","avatar_url":"https://github.com/webaverse.png","language":"JavaScript","readme":"\n# API BACKEND\n\n## To Use\n\nTo clone and run App you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) v.17(which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:\n\n1. `npm install`\n\n2. Create a `config.json` and paste this in: \n\n\t```\n\t{\n\t    \"accessKeyId\": \"\u003cACCESS_KEY_ID\u003e\",\n\t    \"secretAccessKey\": \"\u003cSECRET_ACCESS_KEY\u003e\"\n\t}\n\t```\n\nYou can get these credentials from Avaer.\n\n3. Create a `cert/` folder. Create 2 new files inside: `fullchain.pem` and `privkey.pem`. Ask Avaer for the certificates.\n\n4. `npm run start` (forever) or `npm run dev` (nodemon).\n\n\n### Technologies\n\nThe App primarily uses the following technologies\n\n* [NodeJS](https://nodejs.org/)\n\n---\n\n### Directory Structure\n\n```bash\n**Root**\n│\n├─ index.js \u003c-- This file starts the api-backend and register all major routes in itself.\n├─ config.json \u003c-- This file controls all of the environment variables in the application.\n```\n\n---\n\n### Registered Routes\n\n| Domain  | Route | Usage |\n|--|--|--|\n| login.exokit.org | `_handleLogin` | Provides the application with the functionality to login via Discrod, Email, Twitter \u0026 Github  |\n| accounts.webaverse.com | `_handleAccounts` | Fetch accounts from redis server   |\n| ai.webaverse.com| `_handleAi` | Handle the openAI codex compiling request from the app.webaverse   |\n\n### Config.json\n\n```json\n\n{\n\n\t\t\"accessKeyId\"\t\t\t: \"\u003cAWS ID\u003e\",\n\t\t\"secretAccessKey\"\t\t: \"\u003cAWS Key\u003e\",\n\t\t\"infuraProjectId\"\t\t: \"\u003cinfuraProjectId\u003e\",\n\t\t\"infuraProjectSecret\"\t: \"\u003cinfuraProjectSecret\u003e\",\n\t\t\"discordApiToken\"\t\t: \"\u003cdiscordApiToken\u003e\",\n\t\t\"discordClientId\"\t\t: \"\u003cdiscordClientId\u003e\",\n\t\t\"discordClientSecret\"\t: \"\u003cdiscordClientSecret\u003e\",\n\t\t\"twitterId\"\t\t\t\t: \"\u003ctwitterId\u003e\",\n\t\t\"twitterConsumerKey\"\t: \"\u003ctwitterConsumerKey\u003e\",\n\t\t\"twitterConsumerSecret\"\t: \"\u003ctwitterConsumerSecret\u003e\",\n\t\t\"twitterAccessToken\"\t: \"\u003ctwitterAccessToken\u003e\",\n\t\t\"twitterAccessTokenSecret\": \"\u003ctwitterAccessTokenSecret\u003e\",\n\t\t\"ngrokToken\"\t\t\t: \"\u003cngrokToken\u003e\",\n\t\t\"twitterWebhookPort\"\t: 123456,\n\t\t\"mainnetMnemonic\"\t\t: \"some key\",\n\t\t\"rinkebyMnemonic\"\t\t: \"some key\",\n\t\t\"polygonMnemonic\"\t\t: \"some key\",\n\t\t\"testnetpolygonMnemonic\": \"some key\",\n\t\t\"treasuryMnemonic\"\t\t: \"some key\",\n\t\t\"encryptionMnemonic\"\t: \"some key\",\n\t\t\"infuraKey\"\t\t\t\t: \"\u003cinfuraKey\u003e\",\n\t\t\"polygonVigilKey\"\t\t: \"\u003cpolygonVigilKey\u003e\",\n\t\t\"redisKey\"\t\t\t\t: \"\u003credisKey\u003e\",\n\t\t\"devPassword\"\t\t\t: \"\u003copenai\u003e\",\n\t\t\"openAiKey\"\t\t\t\t: \"\u003copenAiKey\u003e\"\n\n}\n\n```\n____\n### Development Mode\n\nThe application uses vite to hot reload itself automatically if there are any changes to any files. To start the App in dev mode, run:\n\n```bash\nnpm run dev\n```\n:::note \nAny changes inside the `packages` folder won't recompile automatically and so will require restarting the entire development server by just running again: `npm run dev`\n:::\n\n---\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebaverse%2Fapi-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebaverse%2Fapi-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebaverse%2Fapi-backend/lists"}