Skip to content
/ afront Public

AFront is a powerful framework for scalable, high-performance web apps with SSR and customizable UI components. πŸš€

License

Notifications You must be signed in to change notification settings

Asggen/afront

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

29 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AFront

AFront is a powerful framework for building scalable, high-performance web applications with ease. This README provides instructions on how to get started with the project.

πŸš€ Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

Installation

  1. Install AFront

    • Open your terminal or command prompt.

    • To create a new project in a custom folder, run the following command:

      npx afront <your-folder-name>
    • To create the project in the current directory, run:

      npx afront .
    • Navigate to the root folder of the newly created project:

      cd path/to/your/project

Running the Project

  • For Development: Start the development server:
    npm start

For Server-Side Rendering (SSR) Production: Build and run the SSR version:

npm run prod:ssr

For Static Production: Build and serve the static version:

npm run static

πŸ“„ Documentation

For detailed documentation and usage instructions, please refer to the Getting Started Guide.

🀝 Contributing

If you'd like to contribute to the project, please follow the guidelines in the CONTRIBUTING.md.

πŸ“ License

This project is licensed under the MIT License.


Thank you for using AFront! We look forward to seeing what you build with it. If you have any questions or need support, please open an issue on the GitHub repository.

This `README.md` file provides clear instructions on prerequisites, installation, and running the project in different environments. You can customize the links and details as needed for your specific project.

Changes Made:

  1. Prerequisites: Clarified that Node.js must be installed.
  2. Installation: Added instructions to run npx afront <your-folder-name> to create a custom folder or npx afront . to create the project in the current directory.
  3. Running the Project: This section remained the same.

You can now use this updated README.md in your project.