Lightemerald
d93bfe333d
- Added better anti DoS protection - Added better security measures (HTTP headers, etc.) - Added TLS support - Added support for configurable rate limiting - Added default 404 and error handling - Updated proxy settings - Updated env naming
38 lines
876 B
Markdown
38 lines
876 B
Markdown
# HSP-GDH (API)
|
|
|
|
Short description of your project.
|
|
|
|
## Table of Contents
|
|
|
|
- [HSP-GDH (API)](#hsp-gdh-api)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
|
|
## Installation
|
|
|
|
1. Install [bun](https://bun.sh/).
|
|
2. Clone the repository.
|
|
3. Install the dependencies by running the following command:
|
|
```bash
|
|
bun install
|
|
```
|
|
4. Copy .env.sample as .env
|
|
```bash
|
|
cp .env.sample .env
|
|
```
|
|
5. (Optional) Setup SSL/TLS certs
|
|
1. Create Certificate
|
|
```bash
|
|
openssl req -newkey rsa:2048 -nodes -keyout certs/domain.key -x509 -days 365 -out certs/domain.crt -subj "/C=FR/L=Paris/O=HSP-GDH/CN=localhost"
|
|
```
|
|
2. Enable HTTPS in .env
|
|
|
|
|
|
## Usage
|
|
|
|
1. Start the application by running the following command:
|
|
```bash
|
|
bun index.js
|
|
```
|
|
2. Open your browser and navigate to `http(s)://localhost:{port}`. |