Skip to content

github-respository-template.md

Latest commit

 

History

History
125 lines (82 loc) · 5.24 KB

github-respository-template.md

File metadata and controls

125 lines (82 loc) · 5.24 KB

Setup GitHub Repository Template and Issues

Getting Started with the GitHub Repository Template

This template is designed to help you quickly start a new project with predefined issues and a GitHub project board.

💡 Recommendation: Read this entire guide carefully before executing the steps to ensure a smooth setup process.

Step 1: Use the Template

Click on the "Use this template" button on the GitHub template repository page to create your new repository.

Step 2: Create a Personal Access Token

  1. Navigate to Githubs Token Settings: Create Access Token

  2. Personal access token: Click on "Generate new token (classic)".

  3. Token settings: Give your token a descriptive name, set the expiration as desired, and select the repo scope. This allows the token to access repositories.

  4. Generate token: Click "Generate token" at the bottom.

Important: Copy your new personal access token. You won’t be able to see it again!

💡 You can recreate your token at any time, so do not worry if you accidentally did not copy it

Step 3: Setup Environment Variables

  1. Clone your repository: Use git clone to clone your new repository to your local machine.

  2. Create .env file:

    • Navigate to the root directory of your cloned repository.

    • Use the command line to create a copy of the .env.example file:

      cp .env.example .env

    • Open the newly created .env file.

    • Fill in your GitHub username, repository name, and the personal access token you created:

      GITHUB_TOKEN=your_personal_access_token_here
REPO_OWNER=your_github_username
REPO_NAME=your_repository_name
    • Check .gitignore: Ensure that your .env file is listed in your .gitignore file to prevent it from being committed to your GitHub repository.

🚨 If you accidentally pushed your access token to GitHub, make sure to regenerate or remove it as fast as possible! This potentially grants access to your GitHub account.

💡 What is a `.env` file?

In the .env file, you can define variables and their values, which the application will read at runtime. This approach helps keep sensitive information, such as API keys and database credentials, secure and separate from the application's source code.

We need this file for our access token to ensure that the token remains private and is not hard-coded into the source code, protecting it from being exposed publicly.

Step 4: Run the Script to Create Issues

In the root directory of your repository, run the following command to install necessary dependencies and run the issue creation script:

npm install
npm run create-issues

💡 This script will automatically create predefined issues in your repository.

🚨 Make sure to run npm run create-issues only once for your repository.

✅ After creating the issues, you can revoke the token you created if you do not want to let it expire.

Step 5: Create a GitHub Project Board

  1. Go to your repository on GitHub.
  2. Click on "Projects": Find the "Projects" tab and click on it.
  3. Create a new project: Click "New project", choose the "Board" template and name your project.
  4. Ensure that the visibility of your board is set to 'public'.

Step 6: Bulk Add Issues to the Project Board

  1. Add issues: Click on "Add item" in the "ToDo" column.
  2. Select issues: Click on the "+" and "Add item from repository".
  3. Select repository: Select your project.
  4. Add to project: Select all items and click "Add selected items".

Step 7: Deploy to Vercel

  1. Go to Vercel: Visit Vercel and sign up or log in.
  2. Import your project: Click on "New Project" and select your GitHub repository.

Step 8: Add Team Members

To ensure smooth collaboration, you need to add your team members as collaborators to both the GitHub repository and project board. Follow the steps below:

1. Add Team Members to the GitHub Repository

  1. Navigate to your repository on GitHub.
  2. Click the "Settings" tab at the top of the repository page.
  3. In the sidebar, click "Collaborators and Teams" under the Access section.
  4. Click the "Add Collaborator" button.
  5. Enter the GitHub username or email of each team member.
  6. Select the appropriate permission level (Write access is recommended for collaboration).
  7. Click "Add" to invite your team members.

2. Add Team Members to the Project Board

  1. Navigate to the Project Board linked to your repository.
  2. Click the "Menu" button in the upper-right corner to open the board settings if not already visible.
  3. Click "Settings" and then "Manage Access".
  4. Click "Add Collaborators" and search for your team members by their GitHub username.
  5. Assign them the necessary access level to collaborate on the board.

3. Confirm Invitations

  • Your team members will receive an email or GitHub notification to accept the invitation.
  • Ensure all members accept their invitations before starting the project to avoid access issues.

Step 9: Start working and have fun. 🌈

Start the development server:

npm run dev