|
| 1 | +# GitHub Repository Line of Code Calculator |
| 2 | + |
| 3 | +Simplify GitHub repository analysis with our Line of Code Calculator. Quickly input the owner and repository name to obtain total lines of code, providing valuable insights for developers and project managers. Effortlessly streamline codebase assessments for enhanced efficiency. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +Make sure you have the following software installed on your machine: |
| 8 | + |
| 9 | +- [Node.js](https://nodejs.org/) (version 14 or higher) |
| 10 | +- [npm](https://www.npmjs.com/) (comes with Node.js) |
| 11 | +- [Git](https://git-scm.com/) (optional but recommended) |
| 12 | + |
| 13 | +## Recommended IDE Setup |
| 14 | + |
| 15 | +[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). |
| 16 | + |
| 17 | +## Getting Started |
| 18 | + |
| 19 | +1. **Clone the Repository:** |
| 20 | + |
| 21 | + ```sh |
| 22 | + git clone https://github.com/mhamid49/GitHub-Repository-Line-of-Code-Calculator.git |
| 23 | + ``` |
| 24 | + |
| 25 | +2. **Navigate to the Project Directory:** |
| 26 | + |
| 27 | + ```sh |
| 28 | + cd GitHub-Repository-Line-of-Code-Calculator |
| 29 | + ``` |
| 30 | + |
| 31 | +3. **Configure Environment Variables:** |
| 32 | + |
| 33 | + Create a .env file in the root of the project and set the following variables: |
| 34 | + |
| 35 | + ```env |
| 36 | + VITE_BASE_URL=http://127.0.0.1:5173 |
| 37 | + VITE_GITHUB_ACCESS_TOKEN=your-github-access-token |
| 38 | + ``` |
| 39 | + |
| 40 | +## Project Setup |
| 41 | + |
| 42 | +1. **Install Dependencies:** |
| 43 | + |
| 44 | + ```sh |
| 45 | + npm install |
| 46 | + ``` |
| 47 | + |
| 48 | +2. **Run the Application:** |
| 49 | + |
| 50 | +- Compile and Hot-Reload for Development: |
| 51 | + |
| 52 | + ```sh |
| 53 | + npm run dev |
| 54 | + ``` |
| 55 | + |
| 56 | +- Compile and Minify for Production: |
| 57 | + |
| 58 | + ```sh |
| 59 | + npm run build |
| 60 | + ``` |
| 61 | + |
| 62 | +- Lint with [ESLint](https://eslint.org/): |
| 63 | + |
| 64 | + ```sh |
| 65 | + npm run lint |
| 66 | + ``` |
| 67 | + |
| 68 | +## Customize configuration |
| 69 | + |
| 70 | +See [Vite Configuration Reference](https://vitejs.dev/config/). |
0 commit comments