Powered by Cookiecutter, Nexical Cookiecutter Core Interface Template is a framework for jumpstarting production-ready Django Nexical frontend sites quickly.
- If you have problems with Cookiecutter Django, please open issues don't send emails to the maintainers.
Let's pretend you want to create a Nexical project called "redditresearch". Rather than using startproject and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.
First, get Cookiecutter:
$ pip install "cookiecutter>=1.7.0"
Now run it against this repo:
$ cookiecutter https://github.com/fractalsynapse/nexical-core-interface-template
You'll be prompted for some values. Provide them, then a Nexical Core Interface Django project will be created for you.
Answer the prompts with your own desired options. For example:
Cloning into 'nexical-core-interface-template'...
remote: Counting objects: 550, done.
remote: Compressing objects: 100% (310/310), done.
remote: Total 550 (delta 283), reused 479 (delta 222)
Receiving objects: 100% (550/550), 127.66 KiB | 58 KiB/s, done.
Resolving deltas: 100% (283/283), done.
project_name [Nexical Core Interface]: Reddit Research
project_slug [reddit_research]: reddit
description [Starter project for building Django based Nexical AI interfaces]: A reddit research platform.
Select open_source_license:
1 - Apache Software License 2.0
2 - Not open source
Choose from 1, 2 [1]: 1
domain_name [nexical.ai] reddit.example.com
from_email [Nexical AI <[email protected]>]: [email protected]
contact_email [[email protected]]: [email protected]
mailgun_api_key []: ...,
mailgun_webhook_key []: ...,
mailgun_domain []: reddit.example.com
Enter the project and take a look around:
$ cd reddit/
$ ls
Create a git repo and push it there:
$ git init
$ git add .
$ git commit -m "Initial commit."
$ git remote add origin [email protected]:fractalsynapse/reddit_research.git
$ git push -u origin main
Now take a look at your repo.
- If you think you found a bug or want to request a feature, please open an issue.
- For anything else, you can chat with us on Discord.
Need a stable release? You can find them at https://github.com/fractalsynapse/nexical-core-interface-template/releases
This is a starting point. It might not be what you want. If so, you have options:
If you have differences in your preferred setup, we encourage you to fork this to create your own version. Once you have your fork working, let us know and I'll add it to a 'Similar Cookiecutter Templates' list here. It's up to you whether to rename your fork.
If you do rename your fork, I encourage you to submit it to the following places:
- cookiecutter so it gets listed in the README as a template.
- The cookiecutter grid on Django Packages.
We accept pull requests if they're small, atomic, and make the project development experience better.
- Why cookiecutter-django is Essential for Your Next Django Project - Aug. 4, 2024
- How to Make Your Own Django Cookiecutter Template! - Aug. 10, 2023
- Exploring with Cookiecutter - Dec. 3, 2016
- Introduction to Cookiecutter-Django - Feb. 19, 2016