Prerequisites
Before you begin:
- Install Node.js v16 or higher (LTS recommended)
- Git CLI installed and configured
- Basic command line proficiency
1. Clone the Project
Copy the repository from GitHub to your local machine using Git.
git clone https://github.com/elfa/project.git
Change directory into the project folder:
cd project
2. Install Dependencies
The project uses several open source libraries which are managed via npm.
npm install
This will fetch and install all required packages into the /node_modules/ directory.
3. Set Up Config
Copy the environment template and modify API keys as needed:
cp .env.sample .env
Edit .env file with your credentials
4. Start Development Server
Start the development server with hot reloading enabled:
npm run dev
Your application will run at http://localhost:3000
Troubleshooting
Common Errors
- • Node version mismatch? Use 'nvm use'
- • Missing .env file? Run 'cp .env.sample .env'
- • Port 3000 in use? Change port in .env