53 lines
795 B
Markdown
53 lines
795 B
Markdown
# 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
|