# AFront

[![NPM Version][npm-version-image]][npm-url]
[![afront](https://snyk.io/advisor/npm-package/afront/badge.svg)](https://snyk.io/advisor/npm-package/afront/badge.svg)
[![install size](https://packagephobia.com/badge?p=afront)](https://packagephobia.com/result?p=afront)
[![publish size](https://badgen.net/packagephobia/publish/afront)](https://www.npmjs.com/package/afront)
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
[![License][license-src]][license-href]


**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:

- **Node.js**: You must have Node.js installed on your system. Download it from the [Node.js official website](https://nodejs.org/).

### Installation

1. **Install AFront**

   - Open your terminal or command prompt.
   - To create a new project in a custom folder, run the following command:
     ```bash
     npx afront <your-folder-name>
     ```
   - To create the project in the current directory, run:
     ```bash
     npx afront .
     ```

   - Navigate to the root folder of the newly created project:
     ```bash
     cd path/to/your/project
     ```

### Running the Project

- **For Development**: Start the development server:
  ```bash
  npm start
  ```

## For Server-Side Rendering (SSR) Production: Build and run the SSR version:
  ```bash
  npm run prod:ssr
  ```
## For Static Production: Build and serve the static version:
  ```bash
  npm run static
  ```

## 📄 Documentation

For detailed documentation and usage instructions, please refer to the [Getting Started Guide](https://github.com/Asggen/afront/).

## 🤝 Contributing

If you'd like to contribute to the project, please follow the guidelines in the [CONTRIBUTING.md](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](https://github.com/Asggen/afront/issues).


```arduino
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.



[npm-url]: https://npmjs.org/package/afront
[npm-version-image]: https://badgen.net/npm/v/afront
[npm-downloads-image]: https://badgen.net/npm/dm/afront
[npm-downloads-url]: https://npmcharts.com/compare/afront?minimal=true
[license-src]: https://badgen.net/github/license/Asggen/afront
[license-href]: https://github.com/Asggen/afront/blob/main/LICENSE