Laravel-based API-secured anonymous chat platform developed for the Treblle API Security Hackathon.
Anonymous Comrades is a Laravel-based API-secured anonymous chat platform developed for the Treblle API Security Hackathon. It aims to explore innovative techniques for ensuring privacy, anonymity, and secure communication in an anonymous chat application. Let's revolutionize the world of secure and confidential conversations together using Treblle !
The Anonymous Comrades project utilizes the following technologies:
To spin up the Anonymous Comrades application locally, follow these steps:
Clone the repository:
git clone https://github.com/ttebify/anonymous-comrades.git
Navigate to the project directory:
cd anonymous-comrades
Install the dependencies using Composer:
composer install
Create a copy of the .env.example file and rename it to .env. Update the necessary configuration values, such as the database connection details and Treblle API credentials.
Generate a new application key:
php artisan key:generate
Run the database migrations and seed the database:
php artisan migrate:fresh --seed
Start the development server:
php artisan serve
Open your web browser and visit http://localhost:8000
to access the Anonymous Comrades application.
To run the project on your local development server with SSL enabled, you can utilize ngrok as a proxy server. Ngrok masks the localhost URL and provides a usable URL for your application.
Follow this steps:
php artisan serve
to start the server../ngrok http <port>
, where <port>
is the port number your local development server is running on. For example, if you ran php artisan serve
, the default port is 8000, so the command would be ./ngrok http 8000
. Ngrok will generate a unique URL for your local development server, which you can access from anywhere.Ensure that you adjust the instructions according to your specific setup and requirements.
Design and Requirements: Link to Design and Requirements Document
Postman Collection: Link to Anonymous Comrades Postman Collection
This project is licensed under the MIT License. Feel free to use and modify the codebase as per the terms of the license.
We would like to express our gratitude to the Treblle team for organizing the API Security Hackathon and providing the opportunity to build innovative and secure APIs. Thank you for your support!