A platform for building, deploying, and hosting web applications, inspired by platforms like Vercel. Next Live aims to simplify the process of getting your code from repository to live URL.
- Connect with Git providers (currently GitHub).
- Automatically detect and build applications using Docker.
- Support for custom Dockerfiles.
- Asynchronous deployment processing with concurrency limits.
- Dynamic Nginx proxy configuration for deployed applications.
- Status tracking for deployments via API.
- Backend: Node.js, TypeScript, GraphQL (Apollo Server)
- Database: PostgreSQL (with Prisma ORM)
- Build & Containerization: Docker
- Process Management: PM2
- Reverse Proxy: Nginx
- Authentication: JWT, OAuth (GitHub)
- Utilities: Custom in-memory queue
- Operating System: Linux or Windows Subsystem for Linux (WSL 2). The backend is designed to run in a Linux environment.
- Node.js: Version 18 or higher.
- npm or Yarn or pnpm: A Node.js package manager.
- Docker: Docker Engine must be installed and running. The user running the backend process must have permissions to interact with the Docker daemon (e.g., be in the
dockergroup). - PostgreSQL: A running PostgreSQL database instance.
- PM2: PM2 must be installed globally and running as a daemon. The user running the backend process must have permissions to manage PM2 processes.
- Nginx: Nginx must be installed and running. The user running the backend process must have
NOPASSWDsudopermissions configured for specific Nginx commands (nginx -s reload,tee,ln -sf) to allow dynamic configuration updates. - Git: Git must be installed.
-
Clone the repository:
git clone <repository_url> cd next-live/api # Or wherever your API code is located
Note: If using WSL 2, it is highly recommended to clone the repository into your native WSL 2 filesystem (e.g.,
/home/youruser/next-live/api) rather than a mounted Windows drive (/mnt/c/,/mnt/d/) to avoid permission issues with tools like Git and Prisma. -
Install dependencies:
npm install # or yarn install or pnpm install -
Set up the database:
- Ensure your PostgreSQL database is running.
- Configure your database connection URL in a
.envfile in theapidirectory. Example:DATABASE_URL="postgresql://user:password@host:port/database?schema=public"
- Run Prisma migrations to create the database schema:
npx prisma migrate dev --name initial_setup
-
Configure environment variables:
- Create a
.envfile in theapidirectory. - Add your database URL (as above).
- Add your JWT secret and GitHub OAuth credentials:
JWT_SECRET="your_super_secret_jwt_key" GITHUB_CLIENT_ID="your_github_client_id" GITHUB_CLIENT_SECRET="your_github_client_secret" # Add any other necessary environment variables
- Create a
-
Configure User Permissions (Crucial for Linux/WSL 2):
- Ensure the user running your Node.js backend process (e.g.,
deploy_user) is added to thedockergroup:(Replacesudo usermod -aG docker your_backend_user
your_backend_userwith the actual username. You may need to log out and back in to WSL 2 for this to take effect). - Configure
NOPASSWDsudo access for the backend user in/etc/sudoersfor Nginx commands. Usesudo visudoand add lines like:(Confirm the exact paths toyour_backend_user ALL=NOPASSWD: /usr/sbin/nginx -s reload your_backend_user ALL=NOPASSWD: /usr/bin/tee /etc/nginx/sites-available/deploy-*.conf your_backend_user ALL=NOPASSWD: /usr/bin/ln -sf /etc/nginx/sites-available/deploy-*.conf /etc/nginx/sites-enabled/deploy-*.confnginx,tee, andlnusingwhich <command>).
- Ensure the user running your Node.js backend process (e.g.,
-
Build the TypeScript code:
npm run build # or your build command -
Run the API:
npm run dev # For development with ts-node # or for production: # pm2 start dist/index.js --name next-live-api
Ensure PM2 is running if using the production command (
pm2 status).
- Navigate to the Web directory:
cd ../web(or wherever your Web code is). - Install dependencies:
npm install - Configure environment variables (e.g., API endpoint URL).
- Run the Web:
npm run dev
- Create a new project: Use the Web or GraphQL mutation
createProjectto add a project with a Git repository URL. - Deploy a project: Use the Web or GraphQL mutation
deployProjectwith the project ID. The API will return a pending deployment record, and the deployment process will run in the background. - Monitor Deployment Status: Use the GraphQL query
deploymentStatus(id: Int!)to fetch the current status and details of a deployment. - Manage Domains: (Future Feature)
- S3 Storage: Store build artifacts in an S3 bucket instead of the local filesystem for better scalability and durability.
- Enhanced Dockerfile Support: Improve detection and handling of user-provided Dockerfiles for various application types.
- Automated Next.js Configuration: Automatically detect Next.js projects and potentially inject/modify
next.config.jsto ensureoutput: "standalone"is enabled for optimized builds (requires careful implementation). - Custom Domains: Allow users to link their own domain names to deployed applications.
- Environment Variable Management: Provide a secure way for users to manage environment variables for their deployed applications.
- Build Logs Streaming: Stream build and deployment logs back to the Web interface in real-time.
- Deployment Rollbacks: Implement functionality to revert to a previous successful deployment version.
- Support for Other Frameworks/Languages: Extend support beyond Next.js to other popular frameworks (React, Vue, Angular) and languages (Python, Go, Ruby) with appropriate build and serving strategies.
- Monitoring and Alerting: Add monitoring for deployed applications and the platform infrastructure.
[MIT License]