Usage
Create Repository¶
In order to generate your repository from the namoon
template, run the following command:
cookiecutter git+ssh://git@github.com/chimefrb/namoona.git
At this point, you will be asked to enter the following parameter details
Template Parameters
- repository [On Github]: chime-frb-night
- project [Python Compatible]: frb_night
- backend [URL Prefix]: night
- author [Name]: Fogell McLovin
- email [Contact Email]: fogell.mclovin@hawaii-residents.com
This will generate a folder named <project-name>
in your present working directory
containining all the relevant files with the proper project layout.
-
Next, create a repository on GitHub. To avoid errors, do not initialize the new repository with README, license, or gitignore files.
-
Navigate to the directory
<project-name>
. -
Push the project directory to GitHub with the
<URL>
from repository's Quick Setup page
First Steps¶
Install Your Package
pip install --upgrade poetry && poetry install
Initialize Git
git init
git add .
Setup pre-commit
poetry pre-commit install
git commit
First Commit
git add . # Adds the files in the local repository and stages them for commit.
git commit -m "project template from namoona"
git add .
git commit -m "project template from namoona"
pre-commit
will not allow you to push code to the Github Repository until it the minimum collaboration standards.
First Push
git branch -M main
git remote add origin <URL>
git remote -v
git push -u origin main