https://github.com/datachefhq/inception
DataChef's project kickstarter! Reproducible, Declarative and Reliable development environments.
https://github.com/datachefhq/inception
Last synced: over 1 year ago
JSON representation
DataChef's project kickstarter! Reproducible, Declarative and Reliable development environments.
- Host: GitHub
- URL: https://github.com/datachefhq/inception
- Owner: DataChefHQ
- License: mit
- Created: 2024-07-17T07:26:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T15:52:04.000Z (over 1 year ago)
- Last Synced: 2025-02-26T17:53:15.988Z (over 1 year ago)
- Language: Jinja
- Homepage:
- Size: 158 KB
- Stars: 21
- Watchers: 4
- Forks: 3
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Inception
[](https://github.com/DataChefHQ/inception "Go to GitHub repo")
[](https://github.com/DataChefHQ/inception/actions?query=workflow:"Test")
[](https://github.com/DataChefHQ/inception/releases/)
[](#license)
Inception is a project kickstarter (scaffolding tool), designed to
improve developer experience and help with fast onboarding. All the
decisions and options provided in these templates, are based on what
we use mainly in [DataChef](https://datachef.co). However, given the
open source nature of this project, feel free to challenge these
decision and help us to improve them.
**Table of Contents**
- [Inception](#inception)
- [In Action](#in-action)
- [Features](#features)
- [Detailed Features](#detailed-features)
- [How to Use](#how-to-use)
- [Prerequisites](#prerequisites)
- [Initialize a New Project](#initialize-a-new-project)
- [Resources](#resources)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)
## In Action
[](https://drive.google.com/file/d/1emSelH7_yrp51NERaaTQ2Hkk_0omBmGA/view?usp=drive_link "Install Inception")
## Features
1. **Opinionated Configuration**: Reduces decision fatigue by
providing fewer, well-chosen options.
2. **Reproducible and Declarative**: Built on [Nix](https://nixos.org)
and [Devenv](https://devenv.sh), ensuring reliable, reproducible
environments.
3. **Multi-Language Support**: Compatible with Python, Node.js, Go,
and Rust.
4. **Enhanced Development Environment**: Includes features like
[dotenv](https://www.dotenv.org/), [LSP](https://langserver.org/),
[difftastic](https://github.com/Wilfred/difftastic), and more.
5. **DevContainer and CodeSpaces Support**: Developers don't even need
a local editor to begin with!
6. **Comprehensive .gitignore**: Includes a well-crafted `.gitignore`
file.
### Detailed Features
| Feature | Python | Node.js | Go | Rust |
| ------------------------- | ------ | ------- | --- | ---- |
| Automatic Changelog | ✅ | ⏳ | ⏳ | ⏳ |
| Automatic Release | ✅ | ⏳ | ⏳ | ⏳ |
| Automatic Versioning | ✅ | ⏳ | ⏳ | ⏳ |
| CI/CD | ✅ | ✅ | ✅ | ✅ |
| Check code docs on commit | ✅ | ⏳ | ⏳ | ⏳ |
| Documentation Generator | ⏳ | ⏳ | ⏳ | ⏳ |
| Editor Config | ✅ | ✅ | ✅ | ✅ |
| Generate Containers | ✅ | ✅ | ✅ | ✅ |
| Language Server | ✅ | ✅ | ✅ | ✅ |
| Pre Commit Hooks | ✅ | ✅ | ✅ | ✅ |
| Type Check | ✅ | ✅ | N/A | N/A |
| Yaml Lint | ✅ | ✅ | ✅ | ✅ |
| devcontainer | ✅ | ✅ | ✅ | ✅ |
| difftastic | ✅ | ✅ | ✅ | ✅ |
| dotenv | ✅ | ✅ | ✅ | ✅ |
## How to Use
### Prerequisites
To start working with Inception, you need:
- [Devenv](https://devenv.sh/getting-started/), version 1.0.0 or higher.
[](https://drive.google.com/file/d/1rfU7zu3ZGXkgcoBQGZ9vnmWYaPveG0bE/view?usp=drive_link "Install Devenv")
- [pipx](https://pipx.pypa.io/stable/) or
[copier](https://copier.readthedocs.io/)
> [!TIP]
> Enabling [direnv](https://direnv.net) allows you to:
>
> 1. Use your own shell configuration in `devenv` session.
> 2. Automatically integrated with your IDE (VSCode and Intellij support
> it out of the box, and for Emacs and Vim you can use suggested
> plugins below).
>
> For more information on how to enable it you can refer to [this wiki
> entry](https://github.com/DataChefHQ/inception/wiki/How-to-enable-direnv%3F).
*Suggested Plguins*:
1. [emacs-direnv](https://github.com/wbolster/emacs-direnv)
2. [direnv.vim](https://github.com/direnv/direnv.vim)
> [!NOTE]
> While installing `devenv` for the first time, you might face the
> following known errors depending to your local setup. Following links
> aim to help you solve them quickly:
>
> - [Add user to the trusted user list](https://github.com/DataChefHQ/inception/wiki/MacOS:-add-user-to-the-trusted-user-list)
> - [Trusting git directory](https://github.com/DataChefHQ/inception/wiki/Trusting-git-directory)
### Initialize a New Project
First, create a project folder and cd into it.
```bash
mkdir awesome-project && cd awesome-project
```
Using pipx:
```bash
pipx run copier copy --trust gh:DataChefHQ/Inception .
```
If you have copier installed locally, use:
```bash
copier copy --trust gh:DataChefHQ/Inception .
```
## Resources
- [Devenv Docs](https://devenv.sh/getting-started/)
- [Nix in 100 Seconds](https://www.youtube.com/watch?v=FJVFXsNzYZQ)
## Contributing
We welcome contributions! Please check out our [contributing
guidelines](CONTRIBUTING.md) to get started.
## License
This project is licensed under the MIT License - see the
[LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to the open-source community for their invaluable
contributions to projects which we are building on:
- [Nix](https://nixos.org)
- [Devenv](https://devenv.sh)
- [Copier](https://copier.readthedocs.io/)
- Inspiration and support from the DataChef team.