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

Update Contributing & .env.local #128

Merged
merged 6 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@

* The new branch name must be the feature that is going to be implemented.
* Fill the fields of the pull_request_template.
* Use the .editorconfig style template for formatting the code.

## TOOLS

* There are recommended extensions for VS Code inside both backend and frontend. Refer to their respective documentation for installation.

## MUST-HAVE SOFTWARE

* Node.js
* Node >= v20.12.2
* Python >= 3.11
* Git
11 changes: 2 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,7 @@ web_modules/

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
Expand Down Expand Up @@ -142,10 +139,6 @@ dist

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
Expand All @@ -169,5 +162,5 @@ venv
htmlcov
.coverage

# env
.env

*.env
1 change: 1 addition & 0 deletions Backend/.dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ __pycache__


# Exclude environment-specific settings
.env.local
.env.example
.env

Expand Down
5 changes: 3 additions & 2 deletions Backend/.env.example → Backend/.env.local
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
MONGO_URI=mongodb://root:root@localhost:27017/
SECRET_KEY_SIGN=f24e2f3ac557d487b6d879fb2d86f2b2
LAMBDA_URL=https://lambda-url.us-east-1.on.aws/path/
DISTRIBUTION_ID=A5K9R3X7Y2B8ZP
# PROD,TEST
ENV_VALUE=PROD
ENV_VALUE=TEST
# STREAMING_LAMBDA,STREAMING_SDK,DB_BLOB
ARCH=STREAMING_LAMBDA
ARCH=DB_BLOB
2 changes: 1 addition & 1 deletion docs/backend/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In this section we will cover:
cd Backend;
```

2. Create the enviroment file in root path with the following data. **Check .env.example file to see format**
2. Use .env.local renameing it to .env for development or create the enviroment file in root path with the following data.

```
* MONGO_URI= uri for connecting into a MongoDB database ( mongodb://root:root@localhost:27017/ )
Expand Down