Welcome to Rustify! π¦
Rustify is a template for kickstarting your Rust projects. Whether you're a seasoned Rustacean or just getting started with the language, Rustify provides a solid foundation for building reliable and efficient software in Rust.
- Cargo Integration: Rustify leverages Cargo, Rust's package manager and build system, to manage dependencies and build your project.
- Configured for Common Tools: This template comes pre-configured with common tools and configurations such as Gitignore, Cargo.toml, and a basic project structure to save you time.
- Testing Framework Included: Rustify includes a testing framework setup, so you can start writing tests for your code right away.
- Documentation Setup: Rustify encourages documentation with a pre-configured setup for Rust's documentation generator, Rustdoc.
- License: A pre-configured Apache License file is included, allowing you to easily choose an open-source license for your project.
To use Rustify to start a new project, follow these simple steps:
- Clone this repository:
git clone https://github.com/gvatsal60/rustify.git
. - Rename the directory to your project name:
mv rustify your-project-name
. - Navigate into your project directory:
cd your-project-name
. - Start coding! π
Note: rustify folder name should be same as the root folder name else change the PROJECT_NAME variable.
rustify/
βββ conf
β βββ docker.mk # Makefile include for Docker configuration
βββ dockerfiles
β βββ Dockerfile.alpine # Dockerfile for building Alpine-based Docker image
βββ Makefile # Main Makefile for project automation
βββ project
β βββ Cargo.lock # Dependency lock file generated by Cargo
β βββ Cargo.toml # Manifest file for Rust project dependencies
β βββ src
β β βββ main.rs # Main Rust source file
β βββ tests
β βββ Cargo.toml # Manifest file for Rust test dependencies
β βββ src
β βββ main.rs # Main Rust test source file
βββ LICENSE # License file for the project
βββ README.md # Project documentation and instructions
Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.
This project is licensed under the terms of the MIT license. See the LICENSE file for details.
Rustify is inspired by various Rust project templates and best practices within the Rust community.
Happy coding with Rustify! If you have any questions or need further assistance, don't hesitate to reach out. ππ¦