-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
1,419 additions
and
2,021 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| # Contributing | ||
|
|
||
| This document is intended for developers interest in making contributions to Labelai. | ||
| This document is intended for developers interest in making contributions to Etiketai. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| This steps will help you to set up your development environment. That includes all dependencies we use to build Labelai and developer tooling. | ||
| This steps will help you to set up your development environment. That includes all dependencies we use to build Etiketai and developer tooling. | ||
|
|
||
| 1. Clone the git repository: `git clone [email protected]:aralroca/labelai.git` | ||
| 2. Go into the cloned folder: `cd labelai/` | ||
| 1. Clone the git repository: `git clone [email protected]:aralroca/etiketai.git` | ||
| 2. Go into the cloned folder: `cd etiketai/` | ||
| 3. Install all dependencies: `yarn` | ||
| 4. Open the app in localhost: `yarn dev` | ||
|
|
||
|
|
@@ -20,7 +20,7 @@ This steps will help you to set up your development environment. That includes a | |
|
|
||
| ## Creating your first Pull-Request | ||
|
|
||
| We try to make it as easy as possible to contribute to Labelai and make heavy use of GitHub's "Draft PR" feature which tags Pull-Requests (short = PR) as work in progress. PRs tend to be published as soon as there is an idea that the developer deems worthwhile to include into Labelai and has written some rough code. The PR doesn't have to be perfect or anything really. | ||
| We try to make it as easy as possible to contribute to Etiketai and make heavy use of GitHub's "Draft PR" feature which tags Pull-Requests (short = PR) as work in progress. PRs tend to be published as soon as there is an idea that the developer deems worthwhile to include into Etiketai and has written some rough code. The PR doesn't have to be perfect or anything really. | ||
|
|
||
| Once a PR or a Draft PR has been created our community typically joins the discussion about the proposed change. Sometimes that includes ideas for test cases or even different ways to go about implementing a feature. | ||
|
|
||
|
|
@@ -36,11 +36,11 @@ Scripts can be executed via `npm run [script]` or `yarn [script]` respectively. | |
|
|
||
| ## How to create a good bug report | ||
|
|
||
| The best way to reproduce the issue on our machine is to provide a list of all the necessary steps to reproduce it. Also would be shared the browser version, operating system version, and Labelai version. As optional you can also upload a GIF or video recording the issue... it would be very helpful! | ||
| The best way to reproduce the issue on our machine is to provide a list of all the necessary steps to reproduce it. Also would be shared the browser version, operating system version, and Etiketai version. As optional you can also upload a GIF or video recording the issue... it would be very helpful! | ||
|
|
||
| To find out the current version of Labelai, you can follow this link: https://labelai.vercel.app/@version | ||
| To find out the current version of Etiketai, you can follow this link: https://etiketai.vercel.app/@version | ||
|
|
||
|
|
||
| ## I have more questions on how to contribute to Labelai. How can I reach you? | ||
| ## I have more questions on how to contribute to Etiketai. How can I reach you? | ||
|
|
||
| For now, as we are a small community, you can contact me directly (Aral) through my email: [email protected]. As we grow, we will look for other platforms for discussions, like GitHub Discussions, Slack or others. | ||
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
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 |
|---|---|---|
| @@ -1,27 +1,3 @@ | ||
| module.exports = { | ||
| experimental: { | ||
| modern: true, | ||
| }, | ||
| webpack(config, { isServer }) { | ||
| // Preact | ||
| const splitChunks = config.optimization && config.optimization.splitChunks | ||
| if (splitChunks) { | ||
| const cacheGroups = splitChunks.cacheGroups | ||
| const preactModules = /[\\/]node_modules[\\/](preact|preact-render-to-string|preact-context-provider)[\\/]/ | ||
| if (cacheGroups.framework) { | ||
| cacheGroups.preact = Object.assign({}, cacheGroups.framework, { | ||
| test: preactModules, | ||
| }) | ||
| cacheGroups.commons.name = 'framework' | ||
| } else { | ||
| cacheGroups.preact = { | ||
| name: 'commons', | ||
| chunks: 'all', | ||
| test: preactModules, | ||
| } | ||
| } | ||
| } | ||
| const withPreact = require('next-plugin-preact') | ||
|
|
||
| return config | ||
| }, | ||
| } | ||
| module.exports = withPreact({}) |
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "name": "labelai", | ||
| "version": "1.0.0", | ||
| "name": "etiketai", | ||
| "version": "1.0.1", | ||
| "private": true, | ||
| "scripts": { | ||
| "dev": "next dev", | ||
|
|
@@ -13,21 +13,21 @@ | |
| "test:watch": "NODE_ENV=test jest --watch" | ||
| }, | ||
| "dependencies": { | ||
| "next": "9.5.4", | ||
| "preact": "10.4.8", | ||
| "preact-render-to-string": "5.1.10", | ||
| "react": "github:preact-compat/react#1.0.0", | ||
| "react-dom": "github:preact-compat/react-dom#1.0.0", | ||
| "react-ssr-prepass": "npm:preact[email protected]" | ||
| "next": "10.0.3", | ||
| "next-plugin-preact": "3.0.3", | ||
| "preact": "10.5.7", | ||
| "preact-render-to-string": "5.1.12", | ||
| "react": "npm:@preact/compat@0.0.3", | ||
| "react-dom": "npm:@preact/[email protected]" | ||
| }, | ||
| "devDependencies": { | ||
| "babel-jest": "26.3.0", | ||
| "babel-jest": "26.6.3", | ||
| "babel-plugin-transform-es2015-modules-commonjs": "6.26.2", | ||
| "babel-preset-minify": "0.5.1", | ||
| "husky": "4.3.0", | ||
| "jest": "26.4.2", | ||
| "prettier": "2.1.2", | ||
| "pretty-quick": "3.0.2" | ||
| "jest": "26.6.3", | ||
| "prettier": "2.2.1", | ||
| "pretty-quick": "3.1.0" | ||
| }, | ||
| "husky": { | ||
| "hooks": { | ||
|
|
@@ -40,4 +40,4 @@ | |
| "semi": false, | ||
| "singleQuote": true | ||
| } | ||
| } | ||
| } | ||
File renamed without changes
File renamed without changes
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
Oops, something went wrong.
f1c4f8dThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: