Fight For Subs API Sources

These are the FFS API server sources.

The FFS Project is accessible from this address.

Theses sources will allow you to build the API's binaries.

By contributing or using this project, you agree to abide by the Code of Conduct when interracting with a community member.

Documentation

The API Endpoints documentation can be found here

Build and run

First of all clone and build the project's Framework

git clone https://github.com/AlexMog/ApiLib.git
cd ApiLib && mvn install

Then, clone and build the project

git clone https://github.com/AlexMog/FFS-Api.git
cd FFS-Api && mvn compile assembly:single

You will need to install the SQL file into your database (located in the "database" directory)

Then, copy and edit the project's settings in the build directory

cp configs.properties.example target/configs.properties
cp databases.json.example target/databases.json.example
cp -r email_templates/ target/email_templates

You can edit thoes files depending on your configurations

Finally, you can run the project! :)

cd target && java -jar ffs-api-{VERSION}-jar-with-dependencies.jar

Bug Report

If you find any bugs, please report it on the Issues page of the project

Deployment

To use the project, you will need to install a RabbitMQ server.
It's used by the project for its internal messaging system between the API and the PubSub service.
Create a VirtualHost for the project.

TODO NEXT STEPS

Built with

• Maven

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Authors

• Alexandre Moghrabi - Initial work - GitHub GitLab

License

This project is under GNU GPLv3 License - see the LICENSE file for details.