Skip to main content

Getting Started

Welcome! This guide will help you get up and running with Rippler.

📋 Prerequisites​

Before you begin, ensure you have the following installed:

For Node.js Projects​

For Python Projects​

For Java Projects​

For Docker Projects​

🚀 Quick Start​

1. Clone the Repository​

git clone --recurse-submodules https://github.com/Citi-Rippler/rippler.git
cd rippler

2. Install Dependencies​

Node.js​

npm install

Python​

pip install -r requirements.txt

Java (Maven)​

mvn install

Java (Gradle)​

./gradlew build

3. Run the Project​

Node.js​

npm start

Python​

python main.py

Java (Maven)​

mvn spring-boot:run

Java (Gradle)​

./gradlew bootRun

Docker​

docker-compose up

🧪 Running Tests​

Node.js​

npm test

Python​

pytest

Java (Maven)​

mvn test

Java (Gradle)​

./gradlew test

🔧 Configuration​

Configuration files are located in:

  • .env - Environment variables (create from .env.example)
  • config/ - Application configuration files

📚 Next Steps​

🆘 Getting Help​

If you encounter issues:

  1. Check the FAQ
  2. Search existing Issues
  3. Create a new issue with details about your problem

📖 Additional Resources​