Skip to content

Starter Code

Generic Repo Template

Here provide some starter code of what a template codebase could look like.

Prerequisites

  • Github setup
  • Node and Python Installed
  • Basic knowledge of Github Commands

Setup & Customization

  1. Clone the generic repo template:
    git clone https://github.com/anote-ai/Template-Repo
    cd Template-Repo
    
  2. Rename project files and folders: Update README.md with new details.
  3. Customize documentation, landing page, backend and assets: Add course syllabus, lesson plans, and resources.
  4. Initialize Git and push to new remote:
    git remote remove origin
    git remote add origin https://github.com/your-org/new-course-repo.git
    git push -u origin main
    

Best Practices

  • Keep README updated with course overview and setup instructions.
  • Use branches for feature development and reviews.
  • Document changes in commit messages clearly.
  • Include CI/CD workflows if applicable.