eigen-minter

README

Go template from Nethermind Angkor team

This is a template for creating a new Go application made by the Nethermind Angkor team.

Clone this template

To create a new repository from this template you can use the Github UI. See the Github documentation for more information about creating a repository from a template.

Initialization

After cloning this repository you need to set up the Go module of the project and the app name. To do that follow the steps below:

1. Initialize Go module with the following command:

   go mod init [module-name]
   

   The module-name could be for instance github.com/NethermindEth/project-name.

2. Run the go mod tidy command to download dependencies. Also you can use the make gomod_tidy command.

3. Rename the cmd/app directory to the name of your application.

4. Set the APP_NAME value in the .env and in the Dockerfile to the name of your application. Make sure is the same name as the directory you renamed in the previous step.

5. Replace the <repo> value in the CONTRIBUTING.md file with url of your repository to make the links work.

6. Replace the <APP_NAME> value in the CONTRIBUTING.md file with the name of your application.

7. Check CODEOWNERS file, currently is an example file and should be updated. You can find it in the .github directory. Also, see this GitHub documentation about CODEOWNERS file.

Documentation

Inside the docs directory you can find a Docusaurus project with the initial structure for the documentation, read the README.md file inside the directory for more information, also you can read the Docusaurus documentation.

Github Actions

This template has a set of Github Actions workflows that can be used to automate the CI/CD process of your application. The workflows are located in the .github/workflows directory.

TODO

• Support devcontainer
• Template for debian package (for PPA)