diff --git a/README.md b/README.md new file mode 100644 index 0000000..e743d5c --- /dev/null +++ b/README.md @@ -0,0 +1,126 @@ + +
+

+

Developer's Portfolio โœจ

+ +

+ It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase my recent projects. Site URL / Demo: + souravmondaldev.me +
+
+ About Me + ยท + Report Bug + ยท + Request Feature +

+

+ +![GitHub contributors](https://img.shields.io/github/contributors/souravmondaldev/souravmondaldev.github.io?color=ffcc66&style=for-the-badge) +![GitHub stars](https://img.shields.io/github/stars/souravmondaldev/souravmondaldev.github.io?color=ffcc66&style=for-the-badge) + + +[![Twitter Follow](https://img.shields.io/twitter/follow/souravmondaldev?color=ffcc66&logo=twitter&logoColor=ffffff&style=for-the-badge)](https://twitter.com/souravmondaldev) +
+[![Site preview](/social-image.png)](https://souravmondaldev.me/) + +## Table of Contents + +- [Technology Stack ๐Ÿ› ๏ธ](#technology-stack-) +- [Structure โš“](#structure-) +- [Sharing ๐Ÿ’—](#sharing-) +- [Prerequisites ๐Ÿช](#prerequisites-) +- [Setup And Deployment ๐Ÿ”ง](#setup-and-deployment-) +- [Contributing ๐Ÿ™Œ](#contributing-) + +## Technology Stack ๐Ÿ› ๏ธ + +Dependencies defined in package.json: + +[Reactjs](https://reactjs.org/) +| [Bootstrap](https://getbootstrap.com/) +| [Typist](https://github.com/jstejada/react-typist) +| [GitHub API](https://developer.github.com/v3/repos/) +| [Instagram API](https://www.instagram.com/developer/embedding/) + +## Structure โš“ + +- Navigation bar (optional) +- Blog (optional) +- Body + - Name | Profession + - Contact / Follow / Find me / Facebook / LinkedIn / GitHub / Instagram / Email / CodePen + - Resume | About me +- About Me + - Display picture (using Instagram API) (optional) + - About myself, my Interests, Goals and Hobbies + - Things I'm good at (Skills) +- Recent Projects (using GitHub API) (optional) +- Footer + - Acknowledgements (contributors) + - Copyrights - open source + - (quote: Dream big, Think big) + +## Sharing ๐Ÿ’— + +Project is open source. Feel free to make your own version. All you need to do is to fork this repository, edit [src/editable-stuff/configurations.json](./src/editable-stuff/configurations.json) and add resume. Mark star โญ if you like the project. + +## Prerequisites ๐Ÿช + +You should have [Node.js](https://nodejs.org/en/) and [Git](https://git-scm.com/) installed on your PC. You should also own a GitHub account. + +## Setup And Deployment ๐Ÿ”ง + +1. To Get Started, Fork this repository to your GitHub account: +2. Clone the forked repo from your account using: + + ```bash + git clone https://github.com//home.git + ``` + +3. Open in editor and edit [src/editable-stuff/configurations.json](./src/editable-stuff/configurations.json) file. + +4. Add your resume as in place of [src/editable-stuff/resume.pdf](./src/editable-stuff/) +5. Change URL in [package.json](./package.json) file: + + ```json + "homepage": "https://.github.io/home" + ``` + + Or for custom deployment, refer [create-react-app.dev](https://create-react-app.dev/docs/deployment/) + +6. Edit [title](./public/index.html#L34) and meta [description](./public/index.html#L13) in [public/index.html](./public/index.html). + +7. After editing run the following bash commands: + + ```bash + npm install + npm start + ``` + +8. To deploy website run: + + ```bash + npm run build + npm run deploy + ``` + + Or for custom deployment, refer [pages.js](./pages.js) + + ```bash + npm run build + npm run custom-deploy + ``` + +9. Congrats your site is up and running. To see it live, visit: + + ```https + https://.github.io/ + ``` + +Facing issues? Feel free to contact at souravmondaldev.cs@gmail.com. + +## Contributing ๐Ÿ™Œ + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. +Thanks to [@shoaeb] (https://github.com/hashirshoaeb)