Initial extract: templates + methodology guide from Ideation
Public, version-controlled source of truth for TeamIDE's project templates, coding conventions, and the build-plan → PM scaffolding rules. Mounted read-only by TeamIDE's planner agent at runtime. Extracted from the personal Ideation repo as a precondition for workspace-projects-agent-spec.md §9.4. Personal Ideation stays private; this repo holds only the publishable methodology.
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
# Getting Started
|
||||
|
||||
> Installation and initial setup guide for [Project Name]
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js 18+
|
||||
- npm
|
||||
- [Additional prerequisites]
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/dcherrera/[ProjectName].git
|
||||
cd [ProjectName]/app
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
1. Copy the environment template:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Configure required environment variables:
|
||||
```env
|
||||
# Required
|
||||
VARIABLE_NAME=value
|
||||
```
|
||||
|
||||
## Running the App
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
./build.sh -dev -open
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
./build.sh -prod
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Architecture Overview](./architecture.md) - Understand the codebase structure
|
||||
- [Development Guide](./development.md) - Learn the development workflow
|
||||
Reference in New Issue
Block a user