Back to Documentation
Getting Started
Getting Started
Set up your development environment and start building with the Anoneurx Platform in minutes.
Prerequisites
- Node.js 18+ (recommended: 20 LTS)
- npm, bun, or pnpm package manager
- Git version control
- MongoDB 7+ (local or Atlas)
- VS Code with ESLint & Prettier extensions
Installation
bash
git clone https://github.com/anoneurx/platform.git cd platform npm install npm run dev
Environment Setup
bash
cp .env.example .env # Required variables: # VITE_API_URL=http://localhost:5000 # MONGODB_URI=mongodb://localhost:27017/anoneurx # JWT_SECRET=your-secret-key # JWT_EXPIRE=7d npm run dev
Project Structure
directory
src/pages/ — Page components (lazy loaded) src/components/ — Reusable UI components src/contexts/ — React context providers src/hooks/ — Custom hooks src/services/ — API service layer src/layouts/ — Layout wrappers server/ — Backend Express server server/routes/ — API route definitions server/models/ — Mongoose models server/middleware/ — Auth, validation, rate limiting
FAQ
What Node.js version is required?
Node.js 18 or higher. We recommend using the latest LTS version (20.x).
Can I use yarn instead of npm?
Yes, yarn works fine. We also support bun and pnpm.
How do I connect to a remote database?
Set MONGODB_URI in your .env file to your MongoDB Atlas connection string.