diff --git a/LICENSE b/LICENSE index 20257cb..f49a4e1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Copyright (c) 2021 MD. Ariful Alam + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + 1. Definitions. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 09973f0..5efe033 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ It's all possible using [GitHub API](https://developer.github.com/v3/) (for auto ✔️ Avatar and Bio\ ✔️ Social Links\ ✔️ Skills\ -✔️ Education\ ✔️ Experience\ +✔️ Education\ ✔️ Projects\ ✔️ Blog Posts @@ -31,6 +31,8 @@ These instructions will get you a copy of the project up and running on your loc You'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. +
+ 1. **[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)** the repo so you have your own project to customize. A "fork" is a copy of a repository. 2. Once you've found a home for your forked repository, **[clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)** it. @@ -48,4 +50,276 @@ npm install 5. Start the development server ```sh npm start -``` \ No newline at end of file +``` + +## 🎨 Customization + +All the magic happens in file src/config. Open it and modify it according to your preference. + +These are the default values: + +
+config.js + +```js +// config.js +module.exports = { + github: { + username: 'arifszn', // Your GitHub org/user name. (Required) + sortBy: 'stars', // stars | updated + limit: 8, // How many projects to display. + exclude: { + forks: false, // Forked projects will not be displayed if set to true. + projects: [] // These projects will not be displayed. example: ['my-project1', 'my-project2'] + } + }, + social: { + linkedin: '', + twitter: '', + facebook: '', + dribbble: '', + behance: '', + medium: '', + devto: '', + website: '', + email: '' + }, + skills: [ + 'JavaScript', + 'React.js', + ], + experiences: [ + { + company: 'Company name 1', + position: 'Software Engineer', + from: 'July 2019', + to: 'Present' + }, + { + company: 'Company name 2', + position: 'Jr. Software Engineer', + from: 'January 2019', + to: ' June 2019' + } + ], + education: [ + { + institution: 'Institution name 1', + degree: 'Bachelor of Science', + from: '2015', + to: '2019' + }, + { + institution: 'Institution name 2', + degree: 'Higher Secondary Certificate (HSC)', + from: '2012', + to: '2014', + } + ], + blog: { + // Display blog posts from your medium or dev.to account. (Optional) + source: 'dev.to', // medium | dev.to + username: 'arifszn', + limit: 5 // How many posts to display. Max is 10. + }, + googleAnalytics: { + // GA3 tracking id/GA4 tag id + id: '' // UA-XXXXXXXXX-X | G-XXXXXXXXXX + }, + themeConfig: { + default: 'light', + + // Hides the theme change switch + // Useful if you want to support a single color mode + disableSwitch: false, + + // Should we use the prefers-color-scheme media-query, + // using user system preferences, instead of the hardcoded default + respectPrefersColorScheme: true, + + // Available themes. To remove any theme, exclude from here. + themes: [ + 'light', + 'dark', + 'cupcake', + 'bumblebee', + 'emerald', + 'corporate', + 'synthwave', + 'retro', + 'cyberpunk', + 'valentine', + 'halloween', + 'garden', + 'forest', + 'aqua', + 'lofi', + 'pastel', + 'fantasy', + 'wireframe', + 'black', + 'luxury', + 'dracula' + ] + } +} +``` +
+ + +### Themes + +There are 21 themes available which can be selected from the dropdown.\ +![Theme Dropdown]() + +Here are some screenshots of different themes.\ +![Theme 1]()\ +![Theme 2]() + + +### Google Analytics + +ezFolio supports both GA3 and GA4. If you do not want to use Google Analytics, keep the id empty. +```js +// config.js +module.exports = { + // ... + googleAnalytics: { + id: '' + }, +} +``` + +Besides tracking visitors, ezFolio will track click event on projects and blog posts, and send them to Google Analytics.\ +![Google Analytics]() + + +### Meta Tags + +Meta tags will be auto generated from configs dynamically. However, you can also manually add meta tags in public\index.html + + +### Avatar and Bio + +Your github avatar and bio will be displayed here.\ +![Avatar Bio]() + + +### Social Links + +ezProfile supports linking social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website and email. +```js +// config.js +module.exports = { + // ... + social: { + linkedin: 'ariful-alam', + twitter: 'arif_swozon', + facebook: '', + dribbble: '', + behance: '', + medium: '', + devto: '', + website: 'https://arifszn.github.io', + email: '' + }, +} +``` + + +### Skills + +To showcase your skills provide them in skills. +```js +// config.js +module.exports = { + // ... + skills: [ + 'JavaScript', + 'React.js', + ], +} +``` + +Empty array will hide the skills section. + + +### Experience + +Provide your job history in experiences. +```js +// config.js +module.exports = { + // ... + experiences: [ + { + company: 'Company name 1', + position: 'Software Engineer', + from: 'July 2019', + to: 'Present' + }, + { + company: 'Company name 2', + position: 'Jr. Software Engineer', + from: 'January 2019', + to: ' June 2019' + } + ], +} +``` + +Empty array will hide the experience section. + + +### Education + +Provide your education history in education. +```js +// config.js +module.exports = { + // ... + education: [ + { + institution: 'Institution name 1', + degree: 'Bachelor of Science', + from: '2015', + to: '2019' + }, + { + institution: 'Institution name 2', + degree: 'Higher Secondary Certificate (HSC)', + from: '2012', + to: '2014', + } + ], +} +``` + +Empty array will hide the education section. + + +### Projects + +Your public repo from github will be displayed here automatically. You can limit how many projects do you want to be displayed. Also you can hide forked or specific repos. + +```js +// config.js +module.exports = { + // ... + github: { + username: 'arifszn', // Your GitHub org/user name. (Required) + sortBy: 'stars', // stars | updated + limit: 8, // How many projects to display. + exclude: { + forks: false, // Forked projects will not be displayed if set to true. + projects: [] // These projects will not be displayed. example: ['my-project1', 'my-project2'] + } + }, +} +``` + +### Blog Posts + +If you have [medium](https://medium.com) or [dev.to](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is 10). + +The posts are fetched by [Article-api](https://github.com/arifszn/article-api). \ No newline at end of file