UnownHash/Flygon-Admin

Admin panel for Flygon

Flygon Admin

Pre Requisites

1. Go 1.20
2. Node 18
3. Yarn 1.22
4. Flygon
5. Golbat (Optional)

Standard Setup

1. Clone Repo

   git clone https://github.com/UnownHash/Flygon-Admin.git

2. Change Directory to the Repo

   cd Flygon-Admin

3. Create the config file

   cp config.toml.example config.toml

4. Fill out the config file

   nano config.toml

5. Install dependencies

   yarn install

6. Compile the client and server

   yarn build

7. Run

   yarn start

Updating

1. Pull repo

   git pull

2. Repeat steps 5-7 from the standard setup

PM2 Setup

1. Install PM2

   npm install pm2 -g

2. Follow steps 1-6 from the standard setup

3. From the root directory, add to PM2:

   pm2 start "yarn start" --name "Flygon-Admin"

4. Save PM2 processes

   pm2 save

Updating

1. Follow steps 5-6 from the standard setup

2. Restart PM2 process

   pm2 restart Flygon-Admin

Docker Setup

1. Clone Repo

   git clone https://github.com/UnownHash/Flygon-Admin.git

2. Change Directory to the Repo

   cd Flygon-Admin

3. Copy docker-compose file

   cp docker-compose.yml docker-compose.override.yml

4. Fill out the docker-compose.override.yml file, not the docker-compose.yml file

   nano docker-compose.override.yml

5. Run docker-compose

   docker-compose up -d

Updating

docker-compose pull
docker-compose down
docker-compose up -d

Development

Pre Requisites

1. Same as above
2. gow (Recommended)

Run the client in dev mode with hot reloading

yarn install
yarn dev