Be notified when your crush crushed you back
To install the project, follow these steps:
- Clone the repository with
git clone https://github.com/afranck64/crush-me-back
- Install the project dependencies: docker and docker-compose
- Set up environment variables in a
.env
file in the project root folder based on the template.env.template
- [Optional] Set up a logging configuration in a
web/log.conf
file based on the templateweb/log.conf.template
. The template can be usedas is
To run the project use the following command:
docker-compose run web
the project will listen to requests send to the socket file sockets/web.socket
To run the project in dev mode use following command:
docker-compose run web_dev
The application will accessible at http://localhost:5000/.
To run tests, run the following command:
docker-compose run test
Contributions are welcome! To contribute, follow these steps:
- Fork the repository.
- Create a branch for your contribution with
git checkout -b my_new_feature
. - Make your changes.
- Submit a pull request on main branch.
This project is licensed under the MIT License.