Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ease the bootstrapping process for newcomers #450

Open
EduardoSimon opened this issue Oct 17, 2024 · 0 comments
Open

Ease the bootstrapping process for newcomers #450

EduardoSimon opened this issue Oct 17, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@EduardoSimon
Copy link

EduardoSimon commented Oct 17, 2024

Please read this entire template before posting any issue. If you ignore these instructions
and post an issue here that does not follow the instructions, your issue might be closed,
locked, and assigned the missing discussion label.

🚀 Feature Proposal

Following the contribution guidelines listed in the project, there's a step in which you have to copy the env.example file to an .env file. As part of the process, you need to fill in some default for the ENV variables required by the application.

I've used the same ones that are listed in docs in order to start up the application.

What about having the default values listed in the docs already filled in the .env.example file?

Motivation

This would make the time to first commit shorter and ease the process for newcomers to start contributing to the project.

Example

The .env.example could look like:

NODE_ENV=development
PORT=3000
LOG_MODE=stdout
LOG_LEVEL=debug
LOG_FILE=
TURBO_TOKEN=wadus
STORAGE_PROVIDER=local
STORAGE_PATH=S3
BODY_LIMIT=104857600
STORAGE_PATH_USE_TMP_FOLDER=true
# AWS S3 Storage Provider
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_REGION=
S3_ENDPOINT=
# MINIO (Use along with AWS S3 Storage Provider)
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_REGION=
S3_ENDPOINT=
# Google Cloud Storage Provider
GCS_PROJECT_ID=
GCS_CLIENT_EMAIL=
GCS_PRIVATE_KEY=
# Azure Blob Storage
ABS_CONNECTION_STRING=

Note: Would you accept contributions to support this new feature? And if so, how you add the Hacktoberfest label?

@fox1t fox1t added the enhancement New feature or request label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants