Roj
a43d05c9b0
Improve README (#206)
|
3 years ago | |
|---|---|---|
| __tests__ | 4 years ago | |
| examples | 3 years ago | |
| gramjs | 3 years ago | |
| .bablerc | 4 years ago | |
| .gitignore | 4 years ago | |
| .npmignore | 4 years ago | |
| .prettierignore | 4 years ago | |
| .prettierrc.json | 4 years ago | |
| LICENSE | 5 years ago | |
| README.md | 3 years ago | |
| babel.config.js | 4 years ago | |
| empty.txt | 4 years ago | |
| jest.config.js | 4 years ago | |
| npmpublish.bat | 4 years ago | |
| package-lock.json | 3 years ago | |
| package.json | 3 years ago | |
| publish_npm.js | 3 years ago | |
| tsconfig.json | 3 years ago | |
| type_doc.js | 3 years ago | |
| webpack.config.js | 3 years ago |
README.md
GramJS
A Telegram client written in JavaScript for Node.js and browsers, with its core being based on Telethon.
Obtaining your app ID and hash
- Follow this link, and login with your phone number.
- Click
API development tools. - Fill in your application details.
There is no need to enter any
URL, and only the first two fields (app title and short name) can be modified later. - Finally, click "Create application".
Running GramJS
GramJS can run on Node.js, browsers and with frameworks like React.
In browsers, GramJS will be using the localStorage to cache the layers.
To get a browser bundle of GramJS, use the following command:
NODE_ENV=development npx webpack
Using the raw API
Currently, you can call any raw API method like await client.invoke(new RequestClass(args)) .
You can find all methods and types at gram.js.org.
Docs
Youu can find the docs at painor.gitbook.io/gramjs visit gram.js.org to see all supported API methods and types.
Asking questions
If you have any question about GramJS, feel free to open a issue or join us at the Telegram group, @GramJSChat.