feat: setup project

.eslintrc.cjs

@@ -0,0 +1,25 @@
+/**
+ * Please refer to the terms of the license agreement in the root of the project
+ *
+ * (c) 2024 Feedzai
+ */
+const ESLINT_CONFIG = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+};
+
+module.exports = ESLINT_CONFIG;

.gitignore

@@ -0,0 +1,54 @@
+
+
+.cache
+.directory
+.DS_Store
+.env
+.fuse_hidden*
+.grunt
+.idea_modules/
+.idea/
+.lock-wscript
+.node_repl_history
+.npm
+.nyc_output
+.sonar/
+.Trash-*
+.vscode/
+*.iml
+*.ipr
+*.iws
+*.log
+*.pid
+*.seed
+*.stTheme.cache
+*.sublime-workspace
+*.tmlanguage.cache
+*.tmPreferences.cache
+*~
+/out/
+atlassian-ide-plugin.xml
+build/Release
+bundlestats.json
+com_crashlytics_export_strings.xml
+coverage-reports
+coverage/
+crashlytics-build.properties
+crashlytics.properties
+cypress/downloads
+cypress/results
+cypress/screenshots
+dist/
+fabric.properties
+lib-cov
+logs
+node_modules
+npm-debug.log*
+pids
+public/
+reports
+results
+sftp-config.json
+snapshots.js
+storybook-static
+styleguide/

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+Thanks for being willing to contribute!
+
+**Working on your first Pull Request?** You can learn how from this _free_
+series [How to Contribute to an Open Source Project on GitHub][egghead]
+
+## Project setup
+
+1. Fork and clone the repo
+2. `$ npm install` to install dependencies
+3. Create a branch for your PR
+
+> Tip: Keep your `main` branch pointing at the original repository and make
+> pull requests from branches on your fork. To do this, run:
+>
+> ```
+> git remote add upstream https://github.com/@feedzai/js-utilities
+> git fetch upstream
+> git branch --set-upstream-to=upstream/master master
+> ```
+>
+> This will add the original repository as a "remote" called "upstream," Then
+> fetch the git information from that remote, then set your local `main`
+> branch to use the upstream master branch whenever you run `git pull`. Then you
+> can make all of your pull request branches based on this `main` branch.
+> Whenever you want to update your version of `main`, do a regular `git pull`.
+
+## Committing and Pushing changes
+
+Please make sure to run the tests before you commit your changes. You can run
+`npm run test` which will run all tests.
+
+## Help needed
+
+Please checkout the [the open issues][issues]
+
+Also, please watch the repo and respond to questions/bug reports/feature
+requests! Thanks!
+
+<!-- prettier-ignore-start -->
+[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
+[issues]: https://github.com/@feedzai/js-utilities/issues
+<!-- prettier-ignore-end -->