Skip to content

chore: improve README, add .env.example, and configure prettier #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
weby-homelab wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: improve README, add .env.example, and configure prettier #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
VITE_API_URL=http://localhost:5000

APP_NAME=monsters

DB_HOST=mysql
DB_PORT=3306
DB_NAME=monsters_db
DB_USER=root
DB_PASSWORD=root
DB_ROOT_PASSWORD=root

DATABASE_URL=mysql://root:root@mysql:3306/monsters_db
8 changes: 8 additions & 0 deletions .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"semi": true,
"trailingComma": "all",
"singleQuote": true,
"printWidth": 100,
"tabWidth": 2,
"useTabs": true
}
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
### Step 1: Download Docker Desktop
Ensure Docker Desktop is installed on your machine. You can download it from [here](https://www.docker.com/products/docker-desktop).

### Step 2: Install python
### Step 2: Install Python
Ensure Python 3.x is installed on your machine. It is required for the database backup and restore scripts located in the `cli/python` directory.

### Step 3: Start Monsters App

Expand Down