🚀 Getting Started

Welcome to Exzly!
This guide walks you through setting up and running Exzly locally. Whether you're building an internal tool, admin dashboard, or custom backend, Exzly gives you a production-ready foundation — fast. 🏗️

---

• 🚀 Getting Started
  • 🧰 Requirements
    • Optional (Recommended)
  • 📦 Installation Steps
    • 1. Clone the Repository
    • 2. Install Dependencies
    • 3. Setup Environment Variables
  • 🧬 Database Setup
  • ▶️ Running the App
    • Development Mode (with Hot Reload):
    • Production Mode:
  • 🧪 Run Tests
  • 🛠️ Enable Extra Features (Optional)
  • 🆘 Need Help?

🧰 Requirements

Before you begin, ensure your environment meets the following:

• ✅ Node.js v20+
• ✅ npm v10+
• ✅ MySQL (or compatible: MariaDB, etc.)

Optional (Recommended)

• 🧪 Postman – for testing API endpoints
• 🔁 PM2 – for managing the app in production
• 🔐 Nginx & SSL – for production-ready reverse proxy

📦 Installation Steps

1. Clone the Repository

git clone https://github.com/agoenks29D/exzly.git
cd exzly

2. Install Dependencies

npm install

3. Setup Environment Variables

Copy and customize the environment configuration:

cp .env.example .env

📌 Don't forget to set your DB credentials, JWT secret, and any other relevant values.

For full environment variable reference, see: README → Environment Setup

🧬 Database Setup

Create a new database (e.g., exzly_production) via your DB client or CLI.

Then run the following command to migrate and seed demo data:

npm run db:demo

Or, for production:

npm run db:start

You can also use sequelize-cli to run specific migrations or seeders manually. See the Migration and Seeder section for more details.

▶️ Running the App

Development Mode (with Hot Reload):

npm run start:dev

Production Mode:

npm start

Once running, open your browser at http://localhost:3000

🧪 Run Tests

To ensure everything is working as expected, run the test suite:

npm test

Or with coverage report:

npm run test:cov

If needed, set up the test DB with:

npm run db:test

🛠️ Enable Extra Features (Optional)

Want to enhance your project with more features? Just check out the Feature Branches page to learn how to add:

• 📝 Blog module
• 🔐 OAuth integrations
• 🔔 Push Notifications
• 📦 Object storage (S3, MinIO), and more

Feature integration is as simple as:

git fetch origin feature/your-feature
git merge origin/feature/your-feature

🆘 Need Help?

You're not alone. If you get stuck:

• 📖 Read the FAQ
• 🛠 Explore the Deployment Guide
• 🧠 Ask in GitHub Discussions
• 🐞 Open an Issue