|
1 | | -<p align="center"> |
2 | | - <a href="https://github.com/GreenTreeTeam/GithubStats"> |
3 | | - <img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png" alt="Logo" width="80" height="80"> |
4 | | - </a> |
5 | | - |
6 | | - <h3 align="center">Github Stats</h3> |
7 | | - |
8 | | - <p align="center"> |
9 | | -Get Github stats of any user in just one click |
10 | | - <br /> |
11 | | - <br /> |
12 | | - <a href="https://stats.greentree.team/">View Demo</a> |
13 | | - · |
14 | | - <a href="https://github.com/GreenTreeTeam/GithubStats/issues">Report Bug</a> |
15 | | - · |
16 | | - <a href="https://github.com/GreenTreeTeam/GithubStats/issues">Request Feature</a> |
17 | | - </p> |
18 | | -</p> |
19 | | - |
20 | | -<details open="open"> |
21 | | - <summary><h2 style="display: inline-block">Table of Contents</h2></summary> |
22 | | - <ol> |
23 | | - <li> |
24 | | - <a href="#about-the-project">About The Project</a> |
25 | | - <ul> |
26 | | - <li><a href="#built-with">Built With</a></li> |
27 | | - </ul> |
28 | | - </li> |
29 | | - <li> |
30 | | - <a href="#getting-started">Getting Started</a> |
31 | | - <ul> |
32 | | - <li><a href="#prerequisites">Prerequisites</a></li> |
33 | | - <li><a href="#installation">Installation</a></li> |
34 | | - </ul> |
35 | | - </li> |
36 | | - <li><a href="#usage">Usage</a></li> |
37 | | - <li><a href="#roadmap">Roadmap</a></li> |
38 | | - <li><a href="#contributing">Contributing</a></li> |
39 | | - <li><a href="#license">License</a></li> |
40 | | - </ol> |
41 | | -</details> |
42 | | - |
43 | | -## About The Project |
44 | | - |
45 | | - |
46 | | - |
47 | | -### Built With |
48 | | - |
49 | | -- [Semantic UI <3](https://semantic-ui.com/) |
50 | | -- [SCSS](https://sass-lang.com/) |
51 | | - |
52 | | -## Getting Started |
53 | | - |
54 | | -To get a local copy up and running follow these simple steps. |
55 | | - |
56 | | -### Installation |
57 | | - |
58 | | -1. Clone the repo |
59 | | - ```sh |
60 | | - git clone https://github.com/GreenTreeTeam/GithubStats.git |
61 | | - ``` |
62 | | -2. Install NPM packages |
63 | | - |
64 | | - ```sh |
65 | | - yarn |
66 | | - ``` |
67 | | - |
68 | | - 3.Start the app |
69 | | - |
70 | | -```sh |
71 | | - yarn start |
72 | | -``` |
73 | | - |
74 | | -## Usage |
75 | | - |
76 | | -Visit [localhost:3000](http://localhost:3000) to view the webpage |
77 | | - |
78 | | -## Roadmap |
79 | | - |
80 | | -See the [open issues](https://github.com/GreenTreeTeam/GithubStats/issues) for a list of proposed features (and known issues). |
81 | | - |
82 | | -## Contributing |
83 | | - |
84 | | -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
85 | | - |
86 | | -1. Fork the Project |
87 | | -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
88 | | -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
89 | | -4. Push to the Branch (`git push origin feature/AmazingFeature`) |
90 | | -5. Open a Pull Request |
91 | | - |
92 | | -## License |
93 | | - |
94 | | -Distributed under the MIT License. See `LICENSE` for more information. |
| 1 | +<p align="center"> |
| 2 | + <a href="https://github.com/GreenTreeTeam/GithubStats"> |
| 3 | + <img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png" alt="Logo" width="80" height="80"> |
| 4 | + </a> |
| 5 | + |
| 6 | + <h3 align="center">Github Stats</h3> |
| 7 | + |
| 8 | + <p align="center"> |
| 9 | +Get Github stats of any user in just one click |
| 10 | + <br /> |
| 11 | + <br /> |
| 12 | + <a href="https://stats.greentree.team/">View Demo</a> |
| 13 | + · |
| 14 | + <a href="https://github.com/GreenTreeTeam/GithubStats/issues">Report Bug</a> |
| 15 | + · |
| 16 | + <a href="https://github.com/GreenTreeTeam/GithubStats/issues">Request Feature</a> |
| 17 | + </p> |
| 18 | +</p> |
| 19 | + |
| 20 | +<details open="open"> |
| 21 | + <summary><h2 style="display: inline-block">Table of Contents</h2></summary> |
| 22 | + <ol> |
| 23 | + <li> |
| 24 | + <a href="#about-the-project">About The Project</a> |
| 25 | + <ul> |
| 26 | + <li><a href="#built-with">Built With</a></li> |
| 27 | + </ul> |
| 28 | + </li> |
| 29 | + <li> |
| 30 | + <a href="#getting-started">Getting Started</a> |
| 31 | + <ul> |
| 32 | + <li><a href="#prerequisites">Prerequisites</a></li> |
| 33 | + <li><a href="#installation">Installation</a></li> |
| 34 | + </ul> |
| 35 | + </li> |
| 36 | + <li><a href="#usage">Usage</a></li> |
| 37 | + <li><a href="#roadmap">Roadmap</a></li> |
| 38 | + <li><a href="#contributing">Contributing</a></li> |
| 39 | + <li><a href="#license">License</a></li> |
| 40 | + </ol> |
| 41 | +</details> |
| 42 | + |
| 43 | +## About The Project |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +### Built With |
| 48 | + |
| 49 | +- [Semantic UI <3](https://semantic-ui.com/) |
| 50 | +- [SCSS](https://sass-lang.com/) |
| 51 | + |
| 52 | +## Getting Started |
| 53 | + |
| 54 | +To get a local copy up and running follow these simple steps. |
| 55 | + |
| 56 | +### Installation |
| 57 | + |
| 58 | +1. Clone the repo |
| 59 | + ```sh |
| 60 | + git clone https://github.com/GreenTreeTeam/GithubStats.git |
| 61 | + ``` |
| 62 | +2. Install NPM packages |
| 63 | + |
| 64 | + ```sh |
| 65 | + yarn |
| 66 | + ``` |
| 67 | + |
| 68 | + 3.Start the app |
| 69 | + |
| 70 | +```sh |
| 71 | + yarn start |
| 72 | +``` |
| 73 | + |
| 74 | +## Usage |
| 75 | + |
| 76 | +Visit [localhost:3000](http://localhost:3000) to view the webpage |
| 77 | + |
| 78 | +## Roadmap |
| 79 | + |
| 80 | +See the [open issues](https://github.com/GreenTreeTeam/GithubStats/issues) for a |
| 81 | +list of proposed features (and known issues). |
| 82 | + |
| 83 | +## Contributing |
| 84 | + |
| 85 | +Contributions are what make the open source community such an amazing place to |
| 86 | +be learn, inspire, and create. Any contributions you make are **greatly |
| 87 | +appreciated**. |
| 88 | + |
| 89 | +1. Fork the Project |
| 90 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 91 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 92 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 93 | +5. Open a Pull Request |
| 94 | + |
| 95 | +## License |
| 96 | + |
| 97 | +Distributed under the MIT License. See `LICENSE` for more information. |
0 commit comments