Skip to content

Commit 5661451

Browse files
committed
docs: Add LICENSE and README files
This commit adds the LICENSE and README files to the repository. The LICENSE file contains the MIT License text, granting permissions for using and distributing the software. The README file provides an introduction to the repository, including its purpose, structure, installation instructions, and usage guidelines.
1 parent 4e784dd commit 5661451

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Taufik Pragusga
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# LeetCode Solutions in TypeScript
2+
3+
Welcome to my collection of LeetCode solutions written in TypeScript. This repository contains my implementations of various LeetCode problems, organized by difficulty.
4+
5+
## Table of Contents
6+
7+
- [LeetCode Solutions in TypeScript](#leetcode-solutions-in-typescript)
8+
- [Table of Contents](#table-of-contents)
9+
- [Introduction](#introduction)
10+
- [Structure](#structure)
11+
- [Installation](#installation)
12+
- [Usage](#usage)
13+
- [Contributing](#contributing)
14+
- [License](#license)
15+
16+
## Introduction
17+
18+
This repository is a personal project where I solve LeetCode problems using TypeScript. It serves as a way to practice and improve my problem-solving skills, as well as to provide a reference for others who are interested in TypeScript solutions for LeetCode challenges.
19+
20+
## Structure
21+
22+
The repository is organized as follows:
23+
24+
```
25+
leetcode-ts/
26+
27+
├── easy/
28+
│ └── *.test.ts # Tests for easy-level problems
29+
├── medium/
30+
│ └── *.test.ts # Tests for medium-level problems
31+
├── hard/
32+
│ └── *.test.ts # Tests for hard-level problems
33+
├── bun.lockb
34+
├── package.json
35+
└── README.md
36+
```
37+
38+
## Installation
39+
40+
To set up the project locally, follow these steps:
41+
42+
1. Clone the repository:
43+
44+
```bash
45+
git clone https://github.com/pragusga25/leetcode-ts.git
46+
```
47+
48+
2. Navigate to the project directory:
49+
50+
```bash
51+
cd leetcode-ts
52+
```
53+
54+
3. Install the dependencies using Bun. If you don't have Bun installed, you can install it [here](https://bun.sh/docs/installation):
55+
56+
```bash
57+
bun install
58+
```
59+
60+
## Usage
61+
62+
You can run the TypeScript tests using the following command:
63+
64+
```bash
65+
bun test
66+
```
67+
68+
## Contributing
69+
70+
Contributions are welcome! If you have a new solution, improvement, or bug fix, please open a pull request. Ensure your code follows the existing structure and includes relevant tests.
71+
72+
## License
73+
74+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)