https://github.com/blackmarllborooo/create-project-struct
A cli tool to create the structure of your project
https://github.com/blackmarllborooo/create-project-struct
app-collector clean-architecture cli collector create-app create-project golang
Last synced: 9 months ago
JSON representation
A cli tool to create the structure of your project
- Host: GitHub
- URL: https://github.com/blackmarllborooo/create-project-struct
- Owner: blackmarllborooo
- Created: 2023-03-04T12:48:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T07:12:14.000Z (about 3 years ago)
- Last Synced: 2025-07-23T12:50:35.796Z (11 months ago)
- Topics: app-collector, clean-architecture, cli, collector, create-app, create-project, golang
- Language: Go
- Homepage:
- Size: 46.9 KB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# create-project-struct
### You no longer have to think about creating the structure of your application yourself!
### About
This is a cli tool will create the base dirs and files of your app for you.
The base structure is taken from this
[repository](https://github.com/golang-standards/project-layout).
### How it works?
You must have Golang & Make installed to run the build.
Clone the repository on your locale machine, open a terminal in the current
dir and run the `go mod tidy` command.
Then in a terminal with the same dir, run the command
`sudo make exec`.
Once finished, you can use the program by calling it in the
terminal with the command `cps`.
### Launch parameters
It's very simple! To create a project in the current
directory, simply call `cps .`, and to create project
in a new directory, simply write what you want your project
to be called. For example `cps my-app`.
### What does this program?
1. Basic structure taken from the standards;
2. Layout of the main file;
3. File `go.mod` with project name;
4. Makefile with parameters:
1. `build`: builds the application;
2. `run`: start the app in dev mode;
3. `test`: rub all tests;
4. `lint`: checks your project for design errors;
5. Creates a local repository;
6. Create a configuration file for `golangci-lint`;
### What is expected next?
Expected in upcoming updates:
1. Building the project in PKGBUILD;
2. Add some flags to select the type of project, some values (eg port for the server) in the terminal;
### Conclusion
If you have any suggestions for changed or improving the
current project or would like to help | participate, you
can contact me at:
1. 3100194@gmail.com
2. t.me/blackmarllbor0
If you liked the project or found it useful, give it a star!
See you soon!