https://github.com/chad-syntax/wordweaver
https://github.com/chad-syntax/wordweaver
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chad-syntax/wordweaver
- Owner: chad-syntax
- Created: 2025-03-06T16:37:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-24T20:45:32.000Z (11 months ago)
- Last Synced: 2025-07-25T01:48:15.975Z (11 months ago)
- Language: TypeScript
- Size: 319 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Setup
This guide provides the basic steps to get the project running locally.
## Prerequisites
- Node.js (v22.14.0 or later recommended)
- Docker
- Docker Compose
## Getting Started
1. **Install Dependencies:**
Open your terminal in the project root directory and run:
```bash
npm install
```
2. **Start Docker Containers:**
Ensure Docker is running on your machine. Then, run the following command to start the necessary services (e.g., database):
```bash
docker compose up -d
```
The `-d` flag runs the containers in detached mode (in the background).
3. **Run the Development Server:**
Start the application in development mode:
```bash
npm run dev
```
After these steps, the application should be accessible (usually at `http://localhost:3000` or a similar address, depending on the project configuration).