@@ -114,27 +114,22 @@ docker run -it your-org/stackcode init
114114 export type SupportedStack = " node-js" | " react" | " your-custom-stack" ; // Add your stack
115115 ```
116116
117- ### Configuration Customization
117+ ### Basic Configuration
118118
119- 1 . ** Default Configuration **
119+ StackCode supports a simple ` .stackcoderc.json ` configuration file to set project defaults:
120120
121- ``` json
122- // Create .stackcoderc in your users' home directories
123- {
124- "defaultAuthor" : " Your Organization" ,
125- "defaultLicense" : " Proprietary" ,
126- "organizationTemplates" : true ,
127- "privateRegistry" : " https://your-npm-registry.com"
128- }
129- ```
121+ ``` json
122+ // .stackcoderc.json (in project root)
123+ {
124+ "features" : {
125+ "commitValidation" : true
126+ }
127+ }
128+ ```
130129
131- 2 . ** Environment Variables**
132- ``` bash
133- # Set organization defaults
134- export STACKCODE_DEFAULT_AUTHOR=" Your Organization"
135- export STACKCODE_PRIVATE_REGISTRY=" https://your-npm-registry.com"
136- export STACKCODE_TEMPLATE_PATH=" /path/to/custom/templates"
137- ```
130+ This configuration currently supports:
131+
132+ - ` commitValidation ` : Enable/disable conventional commit validation
138133
139134### Internationalization
140135
@@ -154,62 +149,6 @@ echo '{"welcome": "Willkommen"}' > packages/i18n/src/locales/de.json
1541492 . ** Dependency Scanning** : Regularly scan dependencies for vulnerabilities
1551503 . ** Access Control** : Restrict who can modify templates and configurations
156151
157- ### Network Security
158-
159- 1 . ** Private Registries** : Use private NPM registries for internal packages
160- 2 . ** VPN Access** : Require VPN for accessing internal StackCode instances
161- 3 . ** Audit Logging** : Log all template generations and modifications
162-
163- ### Template Security
164-
165- 1 . ** Sanitize Inputs** : Validate all user inputs in templates
166- 2 . ** Restrict File Access** : Limit template file system access
167- 3 . ** Code Review Templates** : Review all custom templates for security issues
168-
169- ## 🔄 Update Management
170-
171- ### Versioning Strategy
172-
173- 1 . ** Semantic Versioning** : Follow semver for your organization's version
174- 2 . ** Release Notes** : Maintain detailed changelog for internal releases
175- 3 . ** Testing Pipeline** : Test all changes before deploying to teams
176-
177- ### Update Process
178-
179- ``` bash
180- # Update from upstream
181- git remote add upstream https://github.com/YagoBorba/StackCode.git
182- git fetch upstream
183- git merge upstream/develop
184-
185- # Review changes and test
186- npm test
187- npm run build
188-
189- # Deploy to your organization
190- npm publish --registry https://your-npm-registry.com
191- ```
192-
193- ## 🏗️ Architecture for Organizations
194-
195- ### Centralized Configuration
196-
197- ```
198- Organization Setup:
199- ├── stackcode-config/
200- │ ├── templates/ # Custom organization templates
201- │ ├── configs/ # Default configurations
202- │ └── policies/ # Development policies
203- ├── private-registry/ # Internal NPM registry
204- └── deployment/ # Deployment scripts
205- ```
206-
207- ### Team Integration
208-
209- 1 . ** Team Templates** : Create templates specific to different teams
210- 2 . ** Approval Workflows** : Implement approval processes for new templates
211- 3 . ** Usage Analytics** : Track template usage across teams
212-
213152## 🛠️ Troubleshooting
214153
215154### Common Issues
@@ -232,33 +171,24 @@ Organization Setup:
232171 ls packages/core/dist/templates/
233172 ```
234173
235- 3 . ** Registry Issues**
174+ 3 . ** Build Issues**
236175
237176 ``` bash
238- # Check registry configuration
239- npm config get registry
177+ # Check if templates are properly copied
178+ npm run build
179+ ls packages/core/dist/templates/
240180
241- # Test registry connectivity
242- npm ping --registry https://your-registry.com
181+ # Verify build output
182+ npm test
243183 ```
244184
245- ### Support and Maintenance
246-
247- 1 . ** Internal Documentation** : Maintain organization-specific documentation
248- 2 . ** Support Channels** : Set up internal support channels for StackCode issues
249- 3 . ** Regular Updates** : Schedule regular updates from the upstream repository
250-
251185## 📋 Deployment Checklist
252186
253187- [ ] Repository forked and customized
254188- [ ] Custom templates created and tested
255- - [ ] Configuration files distributed to teams
256- - [ ] Private registry configured (if applicable)
257- - [ ] Security review completed
258- - [ ] Team training conducted
259- - [ ] Monitoring and logging set up
260- - [ ] Update process documented
261- - [ ] Support process established
189+ - [ ] Build process completed successfully
190+ - [ ] Tests passing
191+ - [ ] Documentation updated for customizations
262192
263193## 🤝 Contributing Back
264194
0 commit comments