Skip to content

Expand-sys/ccashfrontend

Repository files navigation

ccashfrontend

This is a Front End for EntireTwix's CCcash API, it allows regular users to access the banks features and do what they like without having to know code or http requests.

Deployment

To begin you must have set up CCash API server which you can find here Github He is much better at documentation than i, but his is also harder to set up so good luck.

From here is will assume you have set up the api server, know its URL and what protocol it is using

if deploying to a serverless application make sure you set the environmental variables first. these are as follows

  • BANKAPIURL=your api url including http/s and the trailing slash NOT BANKF
  • SECURE=true if you have ssl on your front end host
  • SETUP=true when you have set the above this just gets rid of the setup page that will show if it equals false or the .env file is not found
  • PORT=Optional will default to 3000 if not set

if you are deploying on a vps then

  1. git clone repository
  2. run npm install
  3. Set environmental variables (they are no longer set through the webpage) hint: make a .env file in the root and fill in environmental variables as above
  4. run with your favourite node webserver if you dont know any use pm2
  5. restart the application and badda bim badda boom you done

If you want to properly deploy it put it behind a reverse proxy too so you can have virtual hosts and all that shizzaz but im not going to outline that because that is more advanced, and will require a lot of explaining, google how to reverse proxy a nodejs app if you want to know more

Now available as a docker image

docker pull expandsys/ccashfrontend Then docker run -dp 80:3000 expandsys/ccashfrontend When you go to your ip you will find a setup page to enter the details

Credits

https://github.com/LukeeeeBennett/ccash-client-js - API (started using his api because it makes my code cleaner though as of writing this it needs a few changes to work but should be fixed within 24ish hours ive made a pull request)

About

Front end for a minecraft bank api

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published