Skip to content

Zhaith-Izaliel/bootstrappers

Repository files navigation

Contributors Forks Stargazers Issues MIT


Bootstrappers

A collection of bootstrappers to quickly start a project, powered by Nix flake's templates.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a personal collection of opinionated project templates to get you started with your favorite languages. Everything is simple to set up using Nix flake's template.

(back to top)

Built With

  • Nix

(back to top)

Getting Started

To set up a project on any of the languages available here, follow these simple steps.

Prerequisites

Every template has its own requirements managed through a dev-shell in the flake, all you need is Nix.

  • nix >= 2.28.4 (with flake templates)

Installation

  1. Create an empty directory where appropriate
    mkdir my-awesome-project
    cd my-awesome-project
  2. Initialize the directory with the required template
    nix flake init -t "github:Zhaith-Izaliel/bootstrappers#rust"
  3. You're all set to go!

(back to top)

Usage

As long as you know the name of the template, you can simply initialize a new directory with the corresponding command:

nix flake init -t "github:Zhaith-Izaliel/bootstrappers#name"

With name being one of the subdirectory of this repo.

(back to top)

Roadmap

I will add more template as long as it fits my usage.

Of course, you are welcomed to provide your own bootstrapper or update one of them here. As long as the PR is comprehensive enough for me to maintain it or if you plan to help me maintain the bootstrappers if I don't use the languages you're using.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT. See LICENSE.md for more information.

(back to top)

Contact

Zhaith Izaliel - @zhaith-izaliel.bsky.social - zhaith.izaliel@silvered-ivy.games

Project Link: https://github.com/Zhaith-Izaliel/bootstrappers

(back to top)

Acknowledgments

(back to top)

About

A collection of project bootstrappers for Nix with flakes.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors