Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
# Mini-projects

## Project Overview

This repository is designed to help beginners make their first open-source contributions. It contains a collection of mini-projects to practice version control and basic web development skills.

## Tech Stack

- **Languages:** JavaScript (ES6+), HTML5, CSS3
- **Libraries:** React 18.2.0

## Project Structure

The repository consists of 6 separate folders, each containing a distinct project:

- **2 React projects:** textutils, TODO-LIST
- **4 Vanilla JavaScript Projects:** Calculator, Clock, Password Generator, Temperature-Converter

## Installation and Usage

1. Fork the repository.
2. Clone the repository to your local machine:

```bash
git clone https://github.com/<your-username>/Mini-Projects
```

3. Navigate into the project folder.

## How To Run The Vanilla JavaScript Projects

You have two options to run the static projects:

1. **Live Server (Recommended).**
Install the Live Server extension (by Ritwick Dey) in VS Code. Right-click the index.html file and select "Open with Live Server". This will automatically reload the page whenever you save changes.

2. **Direct File Opening.**
Navigate to the project folder and double-click the index.html file. Note that you will need to manually refresh the browser to see your changes.

## How To Run The React Projects

1. Navigate to the project folder (_textutils or TODO-LIST_).
2. Open a terminal in that directory, and install dependencies:

```bash
npm install
```

3. Once installed, start the development server:

```bash
npm run start
```

This will automatically open the app in your default browser.