{"id":23410736,"url":"https://github.com/noblox/noblox.js-server","last_synced_at":"2025-04-09T12:04:33.245Z","repository":{"id":42087754,"uuid":"163319166","full_name":"noblox/noblox.js-server","owner":"noblox","description":"A RESTful API using noblox.js and Koa.","archived":false,"fork":false,"pushed_at":"2024-11-19T00:51:20.000Z","size":413,"stargazers_count":22,"open_issues_count":2,"forks_count":33,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-02T11:06:45.921Z","etag":null,"topics":["noblox","roblox","roblox-api"],"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/noblox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-27T17:14:00.000Z","updated_at":"2024-09-11T07:34:45.000Z","dependencies_parsed_at":"2024-01-23T17:24:39.330Z","dependency_job_id":"b865f063-9ec0-417e-9c83-77b2a63a34d1","html_url":"https://github.com/noblox/noblox.js-server","commit_stats":{"total_commits":12,"total_committers":3,"mean_commits":4.0,"dds":0.6666666666666667,"last_synced_commit":"64ce26cc65cc20ae68828d5744c2cd9410246151"},"previous_names":["suufi/noblox.js-server"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noblox%2Fnoblox.js-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noblox%2Fnoblox.js-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noblox%2Fnoblox.js-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noblox%2Fnoblox.js-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noblox","download_url":"https://codeload.github.com/noblox/noblox.js-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248036063,"owners_count":21037092,"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":["noblox","roblox","roblox-api"],"created_at":"2024-12-22T17:50:46.707Z","updated_at":"2025-04-09T12:04:33.224Z","avatar_url":"https://github.com/noblox.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noblox/noblox.js-server/master/img/noblox.js-server-logo.png\" alt=\"noblox.js-server\" width=\"400\"/\u003e\n    \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eA RESTful API using \u003ca href=\"https://github.com/suufi/noblox.js\"\u003enoblox.js\u003c/a\u003e and \u003ca href=\"https://koajs.com/\"\u003eKoa\u003c/a\u003e.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://standardjs.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-standard-blue.svg?style=flat-square\" alt=\"JavaScript Style Guide\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/R5GVSyTVGv\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-noblox.js-blue.svg?style=flat-square\" alt=\"noblox.js Discord\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://travis-ci.org/noblox/noblox.js-server\"\u003e\u003cimg src=\"https://img.shields.io/travis/noblox/noblox.js-server/master.svg?style=flat-square\" alt=\"Travis Build Status\"/\u003e\u003c/a\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#about\"\u003eAbout\u003c/a\u003e •\n  \u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e •\n  \u003ca href=\"#configuration\"\u003eConfiguration\u003c/a\u003e •\n  \u003ca href=\"https://github.com/suufi/noblox.js/tree/master/examples\"\u003eExamples\u003c/a\u003e •\n  \u003ca href=\"https://www.youtube.com/playlist?list=PLEW4K4VqMUb_VMA3Yp9LI4gReRyVWGTnU\"\u003eYouTube Series\u003c/a\u003e •\n  \u003ca href=\"#credits\"\u003eCredits\u003c/a\u003e •\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n## About\nThis repository hosts the code for a working [RESTful API](https://restfulapi.net/) that utilizes Koa.js to expose [noblox.js](https://github.com/suufi/noblox.js) functions on the internet. Essentially, with this project, you can host it on your own server and interact with the Roblox API through your own Roblox game. \n\n## Prerequisites\n\n- [**node.js**](https://nodejs.org/en/download/current/)\n- a virtual private server (VPS)\n    - To have your code running on a 24/7 basis, you need to use a VPS. We recommend using DigitalOcean for its ease of use and. [This referral link](https://m.do.co/c/14822e4e2d63) provides you with a $100 credit which can be used over 60 days. Other options include Amazon Web Services, Microsoft Azure, and Google Compute Engine. \n    \n## Configuration\n### server.js\nAfter installing this repository on your server, start by creating an `.env` file to house your configuration settings. You can duplicate the `.env.sample` file and fill in the missing details. \n- Unless you know what you are doing, leave the `PORT` number the same.\n- `MAX_RANK` refers to the highest rank (1-254) the logged in account is allowed to promote users to.\n- `API_TOKEN` refers to a secret key to secure your RESTful API to avoid your API being accessed by unauthorized users. It is best to generate a key that isn't easy to guess. You can use [this](https://randomkeygen.com/) website to use an automatically generated key. You need not memorize this key.\n- `COOKIE` refers to the cookie of the logged-in user account the API will execute functions from. To find your cookie, please read [this](https://github.com/suufi/noblox.js#getting-your-cookie-chrome).\n\nAfter your file is configured, use a process manager like [pm2](https://pm2.keymetrics.io/) to have your script run 24/7. We do not provide support for VPS, network, and domain configuration.\n\n\n### noblox.lua\nIf you plan on using the provided Lua module (ModuleScript) in this project, please do the following:\n- Place the script only in `ServerScriptService`.\n- Update the `DOMAIN` value in `CONFIGURATION` to reflect your server's IP address/domain \u0026 port. (e.g. if your domain name is noblox.io and this is running on port 3000, your value here would be `https://noblox.io:3000`)\n- Update the `API_TOKEN` value in `CONFIGURATION` so that it matches what you put earlier in `server.js`.\n- Optional: provide a `DEFAULT_GROUP_ID` to default to having noblox.js functions run on a single group when not specified.\n\n## Credits\n\n* [suufi](https://github.com/suufi) - Lead maintainer\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoblox%2Fnoblox.js-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoblox%2Fnoblox.js-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoblox%2Fnoblox.js-server/lists"}