https://github.com/code100x/muzer
https://github.com/code100x/muzer
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/code100x/muzer
- Owner: code100x
- Created: 2024-08-29T02:39:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T05:35:52.000Z (over 1 year ago)
- Last Synced: 2025-04-08T13:08:51.224Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://muzer.100xdevs.com
- Size: 1.89 MB
- Stars: 213
- Watchers: 5
- Forks: 163
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Muzer - 100xDevs
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [With Docker](#with-docker)
- [Without Docker](#without-docker)
- [Usage](#usage)
- [Contributing](#contributing)
- [Contributors](#contributors)
## Installation
### With Docker
1. Clone the repository:
```bash
git clone https://github.com/code100x/muzer.git
```
2. Navigate to the project directory:
```bash
cd muzer
```
3. Create a `.env` file based on the `.env.example` file and configure everything in both the `next-app` and `ws` folders.
4. Run the following command to start the application:
```bash
docker compose up -d
```
### Without Docker
1. Clone the repository:
```bash
git clone https://github.com/code100x/muzer.git
```
2. Navigate to the project directory:
```bash
cd muzer
```
3. Now Install the dependencies:
```bash
cd next-app
pnpm install
cd ..
cd ws
pnpm install
```
4. Create a `.env` file based on the `.env.example` file and configure everything in both the `next-app` and `ws` folders.
5. For postgres, you need to run the following command:
```bash
docker run -d \
--name muzer-db \
-e POSTGRES_USER=myuser \
-e POSTGRES_PASSWORD=mypassword \
-e POSTGRES_DB=mydatabase \
-p 5432:5432 \
postgres
```
6. For redis, you need to run the following command:
```bash
docker run -d \
--name muzer-redis \
-e REDIS_USERNAME=admin \
-e REDIS_PASSWORD=root \
-e REDIS_PORT=6379 \
-e REDIS_HOST="127.0.0.1" \
-e REDIS_BROWSER_STACK_PORT=8001 \
redis/redis-stack:latest
```
7. Now do the following:
```bash
cd next-app
pnpm postinstall
cd ..
cd ws
pnpm postinstall
```
8. Run the following command to start the application:
```bash
cd next-app
pnpm dev
cd ..
cd ws
pnpm dev
```
9. To access the prisma studio, run the following command:
```bash
cd next-app
pnpm run prisma:studio
```
## Usage
1. Access the application in your browser at http://localhost:3000
2. Access the redis stack at http://localhost:8001/redis-stack/browser
3. Access the prisma studio at http://localhost:5555
## Contributing
We welcome contributions from the community! To contribute to Muzer, follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/fooBar`).
3. Make your changes and commit them (`git commit -am 'Add some fooBar'`).
4. Push to the branch (`git push origin -u feature/fooBar`).
5. Create a new Pull Request.
For major changes, please open an issue first to discuss what you would like to change.
Read our [contribution guidelines](./CONTRIBUTING.md) for more details.
## Contributors
If you continue to face issues, please open a GitHub issue with details about the problem you're experiencing.