Guidelines

Xsite Project Guidelines

This guide provides a structured walkthrough for creating, building, and running projects using the Xsite platform.


Overview

Xsite enables developers to generate full-stack applications by selecting required components through a streamlined UI. The generated projects include:

After generation, a ZIP archive containing the complete source code is provided for download.


Getting Started

1. Initiate Project Creation

  • Log in to the platform.
  • Navigate to the Create Project section.
  • Begin a new project setup by providing the necessary information.

2. Select Components

  • Choose the features and components you want in your project.
  • Preview the selected components before proceeding.

3. Build the Project

  • Click on the Build button to initiate the generation process.
  • Xsite will compile and assemble your project based on selected components.
  • Depending on complexity, this may take several minutes.

4. Download and Extract

  • Go to the Projects Page.
  • Download your generated project ZIP file.
  • Extract it to your local development environment.

Project Structure and Usage

Once extracted, you will have two main directories: one for the frontend (Next.js) and one for the backend (Strapi).

Frontend: Next.js

# Navigate to the frontend directory
cd next
 
# Install dependencies
pnpm install
 
# Start the development server
pnpm dev

Backend: Strapi

# Navigate to the backend directory
cd ../strapi
 
# Install dependencies
pnpm install
 
# Start the Strapi development server
pnpm develop

Notes

  • Ensure you have pnpm installed globally to manage dependencies efficiently.
  • Configuration files (such as .env) may need updates depending on your environment.
  • Both frontend and backend can be deployed independently using platforms like Vercel, Netlify, or a VPS.