Skip to content
/ seed Public

The seed repository for your Flamego middleware modules

License

Notifications You must be signed in to change notification settings

flamego/seed

Folders and files

NameName
Last commit message
Last commit date
Sep 3, 2024
Mar 6, 2022
Aug 31, 2022
Nov 28, 2021
Oct 9, 2022
Nov 28, 2021
Mar 6, 2022
May 19, 2022
Jan 1, 2025
Jan 1, 2025
Mar 7, 2022

Repository files navigation

seed

This repository contains seed files that almost every repository of Flamego middleware module should have.

Using the content

  1. Create an empty repository on GitHub.com.
  2. Download ZIP of this repository, unzip to a directory, then rename the directory to match the middleware name.
  3. Update the Go module name in the go.mod file to match the middleware repository path, e.g.:
    -module github.com/flamego/seed
    +module github.com/flamego/bilibili
  4. Update the package name in the main.go and rename the file to match the middleware name, e.g.:
    -package seed
    +package bilibili
  5. Update the github.repository in the .github/workflows/lsif.yml to match the middleware repository, e.g.:
    -github.repository == 'flamego/seed'
    +github.repository == 'flamego/bilibili'
  6. Update the import_root in the .deepsource.toml to match the middleware repository, e.g.:
    -import_root = "github.com/flamego/seed"
    +import_root = "github.com/flamego/bilibili"
  7. Update the README.md to be about your middleware, a good example is flamego/template's README.

Getting help

License

This project is under the MIT License. See the LICENSE file for the full license text.