Update README.md
This commit is contained in:
parent
fef3f09d22
commit
6b87a70f43
45
README.md
45
README.md
@ -5,4 +5,47 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h1 align="center">ezProfile</h1>
|
<h1 align="center">ezProfile</h1>
|
||||||
<p align="center">Personal portfolio builder from Github with blogs</p>
|
<p align="center">A modern, responsive and customizable portfolio template for Developers!</p>
|
||||||
|
|
||||||
|
ezProfile is an easy-to-customize personal dev portfolio template that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and repositories. Also it includes space to highlight your details, job history, education history, skills and recent blog posts.
|
||||||
|
|
||||||
|
It's all possible using [GitHub API](https://developer.github.com/v3/) (for automatically populating your website with content) and [Article-api](https://github.com/arifszn/article-api) (for fetching recent blog posts).
|
||||||
|
|
||||||
|
✔️ 21 Themes\
|
||||||
|
✔️ Google Analytics\
|
||||||
|
✔️ Meta Tags\
|
||||||
|
✔️ Avatar and Bio\
|
||||||
|
✔️ Social Links\
|
||||||
|
✔️ Skills\
|
||||||
|
✔️ Education\
|
||||||
|
✔️ Experience\
|
||||||
|
✔️ Projects\
|
||||||
|
✔️ Blog Posts
|
||||||
|
|
||||||
|
To view a live example, **[click here](https://arifszn.github.io/ezprofile)**.
|
||||||
|
|
||||||
|
|
||||||
|
## 🛠 Installation & Set Up
|
||||||
|
|
||||||
|
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
3. Change into your new directory.
|
||||||
|
```sh
|
||||||
|
cd ezprofile
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Install dependencies
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Start the development server
|
||||||
|
```sh
|
||||||
|
npm start
|
||||||
|
```
|
||||||
Loading…
x
Reference in New Issue
Block a user