Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/choukseykhushbu/gitzilla

A resume builder for your GitHub profile.
https://github.com/choukseykhushbu/gitzilla

github-api graphql graphql-api graphql-server hacktoberfest hacktoberfest2021 javascript react react-router scss

Last synced: about 1 month ago
JSON representation

A resume builder for your GitHub profile.

Awesome Lists containing this project

README

        

# GitZilla :star2:

![GitZilla Website](./gitzilla.jpg)

## :woman_technologist: Technology Stack
* [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
* [React](https://reactjs.org)
* [React Router](https://reactrouter.com/)
* [Netlify](https://www.netlify.com/)
* [CSS Animations](https://www.youtube.com/playlist?list=PL4cUxeGkcC9iGYgmEd2dm3zAKzyCGDtM5)
* [SASS](https://sass-lang.com/documentation/syntax)

## :round_pushpin: API
[GitHub API](https://docs.github.com/en/graphql)

## :zap: Installation
**1. Clone this repo by running either of the below commands.**

https : `git clone https://github.com/ChoukseyKhushbu/Gitzilla.git`

ssh : `git clone [email protected]:ChoukseyKhushbu/Gitzilla.git`

**2. Now, run the following commands:**

```bash
cd Gitzilla
npm install
```
This will install all the project dependencies.

**3. Create a `.env` file in the project root folder and copy the format of `.env.sample` file.**

- `.env.sample` file contains all the environment variables required for running the project.

**4. Get your `Personal Access Token` by signing in to your github account and then go to your setting -> developer setting -> Personal access tokens -> Generate new token**

- Add this token to your `.env` file

**5. To start the development server run:**
```bash
npm start
```
**6. :tada: Open your browser and go to `https://localhost:3000`**

## :page_facing_up: License
[MIT](./LICENSE) © Gitzilla