An open API service indexing awesome lists of open source software.

https://github.com/mburuwhiz/ewebb


https://github.com/mburuwhiz/ewebb

cyber onlineservices webhost

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# EWEBB CYBER PLATFORM

## Architecture
This project strictly follows a unified architecture constraint. Both the React frontend and Express backend are unified under a **single `package.json`** at the root of the project.
A single `npm install` handles dependencies for the entire application, and `npm run dev` boots both the Vite client and the Express backend concurrently.

## Setup Instructions

1. **Install Dependencies**
Run the single install command from the root directory:
```bash
npm install
```

2. **Environment Variables**
Copy `.env.example` to `.env` in the root directory and securely configure the credentials.
```bash
cp .env.example .env
```

3. **Start Development Server**
This single command starts the system concurrently:
```bash
npm run dev
```

## Initial Admin Login
The initial super-admin credentials must NOT be hardcoded. They are read exclusively from your `.env` file before starting the server.

1. Ensure `ADMIN_USERNAME` and `ADMIN_PASSWORD` are set in `.env`.
2. Start the server.
3. Navigate to `http://localhost:5173/admin/login`.
4. Log in using the exact username and password provided in the `.env` file.

## Mailer Microservice
The Brevo Mailer logic is isolated in a separate microservice located in the `mailer-microservice/` directory.

To start the mailer:
```bash
cd mailer-microservice
npm install
cp .env.example .env # (Update with your Brevo SMTP credentials)
node server.js
```
The main app communicates with this service via HTTP POST using the URL and API Key defined in the root `.env`.