Skip to content

Commit

Permalink
feat: main commit with the project in general to make the first versi…
Browse files Browse the repository at this point in the history
…on and the unit test
  • Loading branch information
Alpha018 committed Sep 3, 2024
1 parent f80155d commit 127bd07
Show file tree
Hide file tree
Showing 27 changed files with 12,845 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
module.exports = {
parser: '@typescript-eslint/parser',
parserOptions: {
project: 'tsconfig.json',
tsconfigRootDir: __dirname,
sourceType: 'module',
},
plugins: ['@typescript-eslint', '@stylistic/ts', 'prettier', 'sonarjs', 'security'],
extends: [
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
'plugin:sonarjs/recommended-legacy',
'plugin:security/recommended-legacy',
],
root: true,
env: {
node: true,
jest: true,
},
ignorePatterns: ['.eslintrc.js'],
rules: {
'@stylistic/ts/semi': 'error',
'@stylistic/ts/indent': ['error', 2],
'@stylistic/ts/quotes': ['error', 'single'],
'@typescript-eslint/interface-name-prefix': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/explicit-module-boundary-types': 'off',
'@typescript-eslint/no-explicit-any': 'off',
},
};
47 changes: 47 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Build with Semantic-Release

on:
push:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [ 18.x, 20.x ]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: Run tests
run: npm run test

release:
runs-on: ubuntu-latest
needs:
- test
steps:
- name: checkout
uses: actions/checkout@v3
with:
token: ${{ secrets.CI_GITHUB_PAT }}
persist-credentials: true
fetch-depth: 0

- name: environment
uses: actions/setup-node@v3
with:
cache: npm
node-version: 18

- name: install dependencies
run: npm i

- name: Semantic Release
env:
GITHUB_TOKEN: ${{ secrets.TOKEN_GITHUB }}
run: npx semantic-release
56 changes: 56 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

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

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx --no -- commitlint --edit $1
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
npm run lint
npm run format
npm run test
git add .
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"singleQuote": true,
"trailingComma": "all",
"arrowParens": "always",
"printWidth": 100
}
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to nestjs-firebase-auth

Thank you for your interest in contributing to nestjs-firebase-auth! We appreciate your contributions and want to make the process as smooth as possible. Please follow these guidelines to ensure your contributions are integrated seamlessly into the project.

## How to Contribute

1. **Open an Issue:** Before starting work on a new feature or bug fix, we recommend opening an issue to discuss your ideas with the development team. This will help us ensure that your changes align with the project's vision and avoid duplicated efforts.

2. **Fork the Repository:** Fork the main repository to your GitHub account. This will allow you to work on your changes independently.

3. **Create a Branch:** Create a new branch in your fork for your changes. Use a descriptive name for the branch that reflects the changes you are making (e.g., `feature/new-feature` or `fix/bug-fix`).

4. **Make Your Changes:** Make your changes in the new branch. Be sure to follow the project's coding conventions and write unit tests for your changes.

5. **Submit a Pull Request:** Once you have finished your changes, submit a pull request from your branch to the main repository. Include a clear description of your changes and any relevant information.

6. **Review and Merge:** The development team will review your pull request and provide feedback. Once your changes have been approved, they will be merged into the main repository.

## Contribution Guidelines

- **Unit Tests:** Write unit tests for all your changes. This will help us ensure code quality and prevent regressions in the future.
- **Documentation:** Make sure to document your changes appropriately. Update existing documentation or create new documentation if necessary.
- **Coding Conventions:** Follow the project's coding conventions. Use a linter to ensure your code adheres to the established rules.
- **Commit Messages:** Write clear and descriptive commit messages that explain the changes you have made, remember you need follow the commit lint rules.

## License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project, which is the MIT License.

## Contact

If you have any questions or need help, please feel free to contact us by opening an issue on GitHub.

Thank you again for your interest in contributing to nestjs-firebase-auth! We look forward to seeing your contributions soon.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#

<div align="center">
<a href="http://nestjs.com/" target="_blank">
<img src="https://nestjs.com/img/logo_text.svg" width="150" alt="Nest Logo" />
</a>
</div>

<h3 align="center">NestJS Passport Strategy for Firebase Auth using Firebase Admin SDK, which includes the Firebase SDK library for use.
</h3>

<div align="center">
<a href="https://nestjs.com" target="_blank">
<img src="https://img.shields.io/badge/built%20with-NestJs-red.svg" alt="Built with NestJS">
</a>
</div>

# Installation

## Resources

Check out a few resources that may come in handy when working with NestJS:

- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).

## Stay in touch

- Author - [Tomás Alegre](https://github.com/Alpha018)

## License

Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = { extends: ['@commitlint/config-conventional'] };
8 changes: 8 additions & 0 deletions nest-cli.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
}
}
Loading

0 comments on commit 127bd07

Please sign in to comment.