Skip to content

Commit 4d63bc8

Browse files
committed
feat: Add README.md with project overview and setup instructions
1 parent 588e3ee commit 4d63bc8

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<div align="center">
2+
<img src="https://i.imgur.com/KVVR2dM.png">
3+
</div>
4+
5+
## About ZyroHub
6+
7+
<p>ZyroHub is a toolkit designed for developers, offering solutions for media conversion and manipulation. It includes a variety of essential tools, eliminating the need to install or rely on multiple software and services to accomplish common tasks.</p>
8+
9+
## Running the project
10+
11+
#### Requirements:
12+
13+
- [Bun](https://bun.sh/)
14+
- [RabbitMQ Server](https://www.rabbitmq.com/)
15+
- [Redis Server](https://redis.io/)
16+
17+
#### 1. Configure the environment variables:
18+
19+
Copy the `.env.example` file to `.env` for production or `.env.development` for development and fill the necessary variables with the appropriate values.
20+
21+
`production`:
22+
23+
```bash
24+
$ cp .env.example .env
25+
```
26+
27+
`development`:
28+
29+
```bash
30+
$ cp .env.example .env.development
31+
```
32+
33+
#### 2. Install the dependencies:
34+
35+
```bash
36+
$ bun install
37+
```
38+
39+
#### 3. Run the project in development mode:
40+
41+
```bash
42+
$ bun run dev
43+
```
44+
45+
#### 4. Build the project:
46+
47+
```bash
48+
$ bun build
49+
```
50+
51+
#### 5. Run the project in production mode:
52+
53+
```bash
54+
$ bun start
55+
```

0 commit comments

Comments
 (0)