Red Piccolo is an ambitious instant messaging application that goes beyond conventional communication. It's designed to be a multi-faceted platform, allowing users not only to share life's moments but also to manage finances with ease and security. Red Piccolo will stand out with its commitment to speed and high security, setting a new standard for instant messaging applications.
The development of Red Piccolo is planned in multiple phases:
- Relay of Telegram: Initially, Red Piccolo will act as a relay for Telegram, allowing users to connect and communicate using their existing Telegram accounts.
- Finances (Potential Crypto Integration): A key phase will introduce financial functionalities, potentially including cryptocurrency transactions, to provide users with a seamless financial exchange experience.
- Artificial Intelligence: AI will play a role in enhancing user interactions, offering intelligent features that adapt to user needs.
- Standalone Product: The final goal is to establish Red Piccolo as a standalone product, independent and full-featured, to serve as a primary platform for users' communication and financial needs.
Before you begin, ensure you have met the following requirements:
- PostgreSQL and Redis must be running on your system.
- PostgreSQL: Set the
DATABASE_URL
environment variable with your PostgreSQL connection string. - Redis: Set the
REDIS_URL
environment variable with your Redis connection string.
- PostgreSQL: Set the
- Node.js and Yarn must be installed for managing front-end dependencies.
- GCC must be installed to compile native extensions.
- Ruby version 3 or higher must be installed for managing back-end dependencies.
To get a local copy up and running follow these simple steps.
- Clone the repository:
git clone https://github.com/urumo/red_piccolo.git
- Install dependencies:
bundle install --jobs 4 yarn install
- Prepare the database:
rails db:prepare
- Precompile the assets
rails assets:precompile
- Start the server:
This will start the Rails application on the default port. Visit http://localhost:3000 in your web browser to view the application.
rails server
- To build the Docker image for production, run:
docker build -t red_piccolo:latest .
- To build the Docker image for development, run:
docker build -f Dockerfile.dev -t redpiccolo:dev .
Replace redpiccolo with the name you prefer for your Docker image.
We welcome contributions to Red Piccolo. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.