-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from felipecastrosales/develop
Develop
- Loading branch information
Showing
284 changed files
with
8,946 additions
and
459 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# CHANGELOG | ||
|
||
## Unreleased | ||
|
||
- None. | ||
|
||
## 2.0.0 - 2023-10-08 | ||
|
||
- 2.0.0 version. | ||
|
||
## 1.0.0 - 2019-02-10 | ||
|
||
- 1.0.0 version. | ||
|
||
<!-- | ||
Inspired in (but adapted to our needs): | ||
- https://keepachangelog.com/en/1.0.0/ | ||
- https://gist.github.com/juampynr/4c18214a8eb554084e21d6e288a18a2c | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# 🤝 Contribution Guide | ||
|
||
## 📋 Topics | ||
|
||
- [🤝 Contribution Guide](#-contribution-guide) | ||
- [📋 Topics](#-topics) | ||
- [🎯 About](#-about) | ||
- [🏆 Important details](#-important-details) | ||
- [🐛 Issues Reporting](#-issues-reporting) | ||
- [🙏 Thanks](#-thanks) | ||
|
||
## 🎯 About | ||
|
||
Hello, I'm glad to see you're interested in contributing to this project. | ||
|
||
Some settings you may have already seen in the README.md file, but it doesn't hurt to repeat them here. | ||
|
||
**TL;DR:** In a simple and *generic* way, you can contribute in this way below: | ||
|
||
- Fork this repository; | ||
- Create a branch with your feature: git checkout -b my-feature; | ||
- Commit your changes: git commit -m 'feat: My new feature'; | ||
- Push your branch: git push origin my-feature. | ||
- Make a pull request, describing the changes you made and await approval. | ||
- You can also make suggestions by opening an issue, reporting bugs or requesting new features. | ||
|
||
## 🏆 Important details | ||
|
||
Details make all the difference. Especially for attentive souls. For people who seek excellence. I will not treat this project differently. | ||
|
||
So let's go! | ||
|
||
I ask you to follow the following steps: | ||
|
||
- Use the [Conventional Commits](https://www.conventionalcommits.org/); | ||
- Use the [GitFlow Workflow](https://www.atlassian.com/br/git/tutorials/comparing-workflows/gitflow-workflow); | ||
- Follow style guides: | ||
- [Dart Style Guide](https://dart.dev/guides/language/effective-dart/style). | ||
- [Flutter Style Guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo). | ||
- Don't forget to follow [flutter_lints](https://pub.dev/packages/flutter_lints) rules. | ||
- Be aware of [dart_code_metrics](https://pub.dev/packages/dart_code_metrics) rules. | ||
- Follow good naming principles, [`Naming Cheatsheet`](https://github.com/kettanaito/naming-cheatsheet), e.g. | ||
- Tests: | ||
- It's always beautiful to receive testable code and even more beautiful with tests. | ||
- Make small commits and pull requests, it's easier to review and understand what you did. | ||
- Read the Code of Conduct before contributing (I like [this](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md)). | ||
- Read recommendations for [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md). | ||
|
||
## 🐛 Issues Reporting | ||
|
||
If you found a bug or have a suggestion, feel free to open an issue. But before doing that, please read the following: | ||
|
||
- Check if the issue was not reported, you can see in [Issues](https://github.com/felipecastrosales/site/issues) tab; | ||
- Provide a clear and consice description of the issue; | ||
- Include screenshots or related files; | ||
- Indicate the expected behavior in comparison to the current behavior; | ||
- Indicate the steps to reproduce the issue; | ||
- Give suggestions on how we can solve this, it's always nice to have new ideas. | ||
|
||
## 🙏 Thanks | ||
|
||
Just seeing your interest in contributing already got me excited. | ||
|
||
Know that even giving a star ⭐️ you will already be collaborating with the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# 🎖️ Contributors | ||
|
||
This is a special area for contributors. | ||
|
||
![GitHub Contributors Image](https://contrib.rocks/image?repo=felipecastrosales/site) | ||
|
||
--- | ||
|
||
[![Contributors over time](https://contributor-graph-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=felipecastrosales/site)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=felipecastrosales/site) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# 🤩 Want to do | ||
|
||
Before I even openly release officially this to community, I already shared it with a few people, as well as already hosted it; and some of them asked me if they could use the model for their own use. And of course, that's why I'm making a point of explaining better how you can make this project yours. | ||
|
||
First, Follow the [🤔 How to Use](./README.md#-how-to-use) steps. | ||
|
||
## Figma | ||
|
||
- See file [here](https://www.figma.com/file/Dgq4C5dLgtWK2sb0KebmEZ/%40felipecastrosales---Portfolio?type=design&node-id=0%3A1&mode=design&t=RTugDZN5S2knn3Nk-1) | ||
- Open project, and duplicate it. | ||
- Change all datas to yours (as images), and export files substituting the originals. | ||
|
||
## Project Datas | ||
|
||
- If you want to change the tokens (colors etc), you can do it in the `lib/app/core/tokens/app_colors.dart` file. | ||
- To change the texts datas: | ||
- Open `lib/app/core/l10n/templates` and change the `.arb` files to yours - or update the existing ones. | ||
- Tip: after you change, you can use the [Chat GPT](https://chat.openai.com/) to convert to other languages - but it's always worth checking the translation. | ||
- After that, discomment the `synthetic-package: false`, inside the [l10n.yaml](l10n.yaml) file. | ||
- Now, is only run the command `flutter gen-l10n` to generate the Dart files. | ||
- And finally, comment the `synthetic-package: false` again, inside the [l10n.yaml](l10n.yaml) file. | ||
|
||
## Contact Form | ||
|
||
- Related to Contact Form: | ||
- Create your account inside `emailjs` and make your changes. | ||
- You can see [this video](https://www.youtube.com/watch?v=9HW3MZ_tsdo), to help you on practice. | ||
|
||
## Firebase | ||
|
||
- Create your Firebase project, and make your necessary changes. | ||
- Configure all, see the [Firebase CLI](https://firebase.flutter.dev/docs/cli/) to help you with productivity. | ||
|
||
### Remote Config | ||
|
||
I put the informations of contact form inside the Remote Config, so create this keys with your information inside your Firebase project: | ||
|
||
- `service_id` | ||
- `template_id` | ||
- `user_id` | ||
- `to_email` | ||
|
||
## Others | ||
|
||
If you want more information or others specific changes, you can open an issue or contact me. I will be happy to help you. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: CI/CD | ||
|
||
on: | ||
push: | ||
tags: | ||
- v* | ||
|
||
jobs: | ||
flutter_test: | ||
name: Run Flutter Analyze and Tests | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: "12.x" | ||
- uses: subosito/flutter-action@v2 | ||
with: | ||
channel: "stable" | ||
- run: flutter pub get | ||
- run: flutter analyze | ||
- run: dart format --set-exit-if-changed lib | ||
- run: dart format --set-exit-if-changed test | ||
- run: flutter test --coverage | ||
- run: flutter test --machine > test-results.json | ||
- uses: dorny/test-reporter@v1 | ||
with: | ||
name: test-results | ||
path: test-results.json | ||
reporter: flutter-json | ||
- uses: VeryGoodOpenSource/very_good_coverage@v2 | ||
with: | ||
min_coverage: 0 | ||
|
||
build_ios: | ||
name: Build Flutter (iOS) | ||
needs: [flutter_test] | ||
runs-on: macos-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: "12.x" | ||
- uses: subosito/flutter-action@v2 | ||
with: | ||
channel: "stable" | ||
- run: flutter pub get | ||
- run: flutter clean | ||
- run: flutter build ios --release --no-codesign | ||
|
||
build_appbundle: | ||
name: Build Flutter (Android) | ||
needs: [flutter_test] | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: "12.x" | ||
- uses: subosito/flutter-action@v2 | ||
with: | ||
channel: "stable" | ||
- run: flutter pub get | ||
- run: flutter clean | ||
- run: flutter build appbundle | ||
- name: Upload appbundle | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: appbundle | ||
path: build/app/outputs/bundle/release/app-release.aab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- develop | ||
- master | ||
pull_request: | ||
branches: | ||
- master | ||
- develop | ||
- feature/* | ||
|
||
jobs: | ||
flutter_test: | ||
name: Run Flutter Analyze and Tests | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: "12.x" | ||
- uses: subosito/flutter-action@v2 | ||
with: | ||
channel: stable | ||
- run: flutter pub get | ||
- run: flutter analyze | ||
- run: dart format --set-exit-if-changed lib | ||
- run: dart format --set-exit-if-changed test | ||
- run: flutter test --coverage | ||
- run: flutter test --machine > test-results.json | ||
- uses: dorny/test-reporter@v1 | ||
with: | ||
name: test-results | ||
path: test-results.json | ||
reporter: flutter-json | ||
- uses: VeryGoodOpenSource/very_good_coverage@v2 | ||
with: | ||
min_coverage: 70 | ||
- uses: codecov/codecov-action@v3 | ||
with: | ||
# token: ${{ secrets.CODECOV_TOKEN }} not required for public repos | ||
file: ./coverage/lcov.info | ||
name: Codecov |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"MD033": { | ||
"allowed_elements": [ | ||
"a", | ||
"sup", | ||
"nobr" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.