clburlison / 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. Create the config file

cp config.toml.example config.toml

3. Fill out the config file

nano config.toml

4. Compile the client

cd client
yarn install
yarn build

5. Compile the server

cd ../server
go build

6. Run server

./server

Updating

1. Pull repo

git pull

2. Repeat steps 4-6 from the standard setup

PM2 Setup

1. Install PM2

npm install pm2 -g

2. Follow steps 1-5 from the standard setup
3. From the server directory, add to PM2:

pm2 start server --name "Flygon-Admin"

4. Save PM2 processes

pm2 save

Updating

1. Follow steps 4-5 from the standard setup
2. Restart PM2 process

pm2 restart Flygon-Admin

Docker Setup

1. Copy docker-compose file

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

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

nano docker-compose.override.yml

3. 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)

Terminal 1

Run the client in dev mode with hot reloading

cd client
yarn install
yarn dev

Terminal 2

Run the server in dev mode with file watching

cd server
gow run . # or go run .