Skip to content

Guardians-Stuff/Dashboard

Repository files navigation

🚀 Installation & Startup Guide

Get Guardian Dashboard running locally with these easy steps! ✨🛡️

1. Prerequisites 🧰

2. Clone the Repository 🌀

Open your terminal and run:

git clone https://github.com/Guardians-Stuff/Dashboard.git

3. Go to the Project Directory 📂

cd Dashboard

4. Install Dependencies 📦

npm install

5. Set Up Environment Variables 📝

Copy the example environment file:

cp .env.example .env.local

Edit .env.local as needed (add your MongoDB URI and any other required secrets 🔑).

6. Start the Development Server ▶️

npm run dev

This launches the dashboard at http://localhost:3000 by default! 🚀


🥳 You’re all set!
Visit http://localhost:3000 in your browser to use Guardian Dashboard. 🦾🖥️

For production or further deployment, check additional instructions in this README. (coming soon) 🚧