diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml new file mode 100644 index 0000000..406b390 --- /dev/null +++ b/.github/workflows/docker-image.yml @@ -0,0 +1,16 @@ +name: Docker Compose CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build and run Docker services + run: docker-compose up --build -d diff --git a/README.md b/README.md new file mode 100644 index 0000000..3984682 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# FiveM Tracker + +Unlock the secrets of FiveM servers with detailed insights and analytics. Discover more about your favorite servers than ever before. + +### Overview +FiveM Tracker is a powerful tool that provides detailed analytics and insights into FiveM servers. + +### Features +- **Detailed Server Information**: Get detailed information about FiveM servers, including player count, server settings, and more. +- **MongoDB Integration**: Utilizes MongoDB for efficient data storage and retrieval. +- **ReactJS Frontend**: The frontend is built with ReactJS, providing a modern and intuitive user interface. +- **Express Backend**: The backend is powered by Express, ensuring fast and reliable server-side operations. + +### Usage +You can easily run FiveM Tracker locally using Docker Compose. Simply run the following command in your terminal: + +``` +docker-compose up -d +``` + +### Support and Contributions +If you encounter any issues or have suggestions for improvement, please open a GitHub issue [here](https://github.com/btwlouis/fivem-tracker/issues). + +Contributions are welcome! Fork the repository, make your changes, and submit a pull request.