fluxor_cli 1.0.0

Fluxor CLI: a command-line tool that allows developers to quickly and efficiently create project starters for the Fluxor web framework.
Documentation

Fluxor CLI is the command-line interface for the Fluxor web framework, enabling rapid project scaffolding and management for Rust applications focused on data science and computing.

SEE CHANGELOG

Features

  • Project Scaffolding: Quickly create new Fluxor projects with pre-configured templates.
  • Version Flexibility: Specify the version of Fluxor to utilize in your projects.
  • Example Templates: Easily initialize projects with example code to kickstart development.

Getting Started

To install the Fluxor CLI, run:


cargo install fluxor_cli


Usage

Once installed, you can create a new Fluxor project with:


fluxor new <project_name> --version latest --example helloworld


Replace <project_name> with your desired project name. Navigate to your project directory:


cd <project_name>

Running The Application To build and run your newly created Fluxor application, use:


cargo run


The application should start on http://127.0.0.1:8080.

All Examples

Hello World

  • helloworld
  • helloworld-api
  • helloworld-api-server

Routes

  • routes
  • routes-project

Assets

  • assets

DotEnv

  • dotenv

Cans

  • cans-template-engine

Fluxor

  • fluxor-template

Use the example name after the flag --example (e.g., helloworld):

fluxor new my_project --version latest --example helloworld

fluxor new my_app --version latest --example routes

fluxor new routes_app --version latest --example routes-project

fluxor new assets_example --version latest --example assets

fluxor new dotenv_example --version latest --example dotenv

fluxor new template_app --version latest --example cans-template-engine

fluxor new fluxor_template --version latest --example fluxor-template

Documentation

For more detailed usage and advanced features, refer to the fluxor & fluxor_cli documentations.

Contributing

Contributions are welcome! Fork the repository and submit a pull request. For larger changes, please discuss them in an issue.

License

Fluxor CLI is licensed under either of the following licenses:

  • MIT License
  • Apache License, Version 2.0

See the LICENSE file for more details.


Author

Dr. Montasir Mirghani