This repository has been archived by the owner on Nov 7, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
87 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,24 +7,87 @@ Meet the lightning-fast Facebook Messenger chatbot, seamlessly managing multiple | |
## Pre-requisites | ||
- Install [Node.js](https://nodejs.org/en/) version 20.x.x | ||
|
||
For better performance i require hosting this program on following platforms | ||
- Digital Ocean (tested) | ||
- Amazon Web Services | ||
- Microsoft Azure (tested) | ||
- Google Cloud | ||
- Replit (tested) | ||
- Termux (tested) | ||
|
||
## Requirements | ||
- 1GB Disk Space | ||
- 1GB RAM or VRAM | ||
- 1 or more CPU/vCPU core <br> | ||
|
||
For vm and vps: | ||
|
||
- Ubuntu, Mint or Arch OS | ||
- Xcfe for DE | ||
- Windows XRDP | ||
|
||
|
||
## Getting started | ||
- Fork the repository <br> | ||
https://github.com/mrepol742/project-orion/fork | ||
- Clone fork the repository | ||
``` | ||
```sh | ||
# using https | ||
git clone https://github.com/<your-username>/project-orion | ||
|
||
# using ssh | ||
git clone [email protected]:<your-username>/project-orion | ||
``` | ||
- Install dependencies | ||
```sh | ||
cd project-orion && npm run setup | ||
# for linux os that uses apt please run | ||
npm run setup_extra | ||
``` | ||
cd project-orion && npm i | ||
``` | ||
- Add your Instance | ||
>There is different ways to add your account instance usually it depends on how you run this program | ||
|
||
- local machine, virtual machine or vps | ||
```sh | ||
# linux | ||
mkdir data | ||
mkdir cookies | ||
touch /data/cookies/instance.bin | ||
nano /data/cookies/instance.bin | ||
# then paste your account instance and save | ||
# windows & macos | ||
open file explorer (or any similar app) | ||
navigate to the project directory | ||
create the following folders and file. | ||
/data/cookies/instance.bin | ||
open instance.bin using any text editor | ||
paste your account instance and save | ||
``` | ||
|
||
- render or any similar platform where u cant edit the deployed files | ||
```sh | ||
open the environment section of the site | ||
click add new env | ||
name it `APP_STATE` | ||
paste your account instance in value input | ||
then save | ||
``` | ||
- Run the project | ||
``` | ||
```sh | ||
# for linux | ||
npm run start | ||
# other than linux | ||
npm run start_win | ||
# for dev | ||
npm run dev | ||
``` | ||
- Eslint | ||
```sh | ||
npm run eslint ./ | ||
``` | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters