Host | Server URL |
---|---|
Official | https://boxbox-server.netlify.app/api/ |
- See the wiki
- See the wiki
At first, you need Go installed.
-
To install Go, follow the installation instructions.
-
To verify whereas Go is installed, run
go --version
in your terminal.
Step-by-step installation of Box, Box! server:
git clone https://github.com/BrightDV/BoxBox-Server.git
cd BoxBox-Server
go run main.go
That's it! Your Box, Box! server is now up and running on your device, on the port 8080 by default!
-
If you wish to change the port used, open the
main.go
file with your favorite text editor and edit the line 43 by replacing8080
with the port that you want to use. -
By default, Box, Box! Server is accessible from any website. If you want to only accept some websites to use your server, edit the line 42 of the
main.go
file and replace the*
with your website(s) base URL(s) (e.g., the origin of the request).
At first, Box, Box! was an Android application. Then, thanks to Flutter, Box, Box! could be deployed as a website. Sadly, almost all the requests were blocked by the CORS of your browser... So here is Box, Box! Server: a proxy designed to provide you all the news and the results without being blocked.
Box, Box! Server is meant to be used with Box, Box! (see the wiki to see the instructions to use your server). It is mainly focused on two use-cases:
- Using Box, Box! Server as a proxy when you use the web version
- Using Box, Box! Server as a tracker-blocker: a lot of trackers are not present when doing the request to the Box, Box! Server (~ 13 to 2 trackers).
If you want to deploy a public version of Box, Box! (which can be listed in the instances' list), then I can whitelist your website to use the official proxy so you don't have to run it too.
Box, Box! Server is Free Software: You can use, study, share, and improve it at
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Contributions are very welcome! I am only a newbie in Go so feel free to modify and improve the code, and, of course, open a PR ;)