Create Your First Application
Step-by-step guide to create a project, configure your environment, and run your first app using our development tools and SDKs.
1. Prerequisites
Development Tools
- Node.js 18.0+ installed
- npm or yarn package manager
- Text editor/IDE (VS Code recommended)
Optional API Access
- API Key
- Rate limit: 1000 requests/minute
2. Install Development Tools
# Install CLI globally
npm install -g platform-cli
# Create new Typescript project
platform new my-app --type=ts
# Navigate to directory
cd my-app
# Install dependencies
npm install
Project Setup
The CLI will create a scaffolded project with TypeScript, ESLint, and Webpack. Choose from several template types during the setup.
Build Configuration
Webpack is configured with hot module replacement enabled by default. TypeScript includes strict type checking and module imports.
Next Steps
Configure your .env file for API keys. Modify tsconfig.json for custom TypeScript settings. Update webpack.config.js as needed.
3. Run Your Application
Start Development Server
npm start
http://localhost:3000.
Verify Configuration
// Create test file: src/tests/config-check.ts
import { config } from 'dotenv';
console.log('ENV Variables:', config);
Run npm run test to ensure environment variables are loaded correctly.
Output: "ENV loaded successfully!"
Common Issues
Environment Variables Missing
Ensure .env file is in the project root. Use VITE_ prefix for frontend environment variables.
TypeScript Errors
Add missing type definitions. Run npm install @types/some-library or update tsconfig.json.
Webpack Build Fails
Delete node_modules and reinstall dependencies. Ensure package.json has proper resolution of dependencies.
Missing CLI
Reinstall CLI globally with npm install -g platform-cli. Verify PATH settings for Node binaries.
Ready to Expand?
Now that your app runs successfully, try extending it using our API. Implement new features like authentication, data integration, or backend services.