StockLearn

Welcome to the StockLearn project. This project includes a frontend application built with Vite and React. Follow the instructions below to set up and run the project on your local machine.

Table of Contents

• Prerequisites
• Getting Started
• Running the Frontend
• Contributing
• License

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm are installed. You can download and install them from nodejs.org.
• Git is installed. You can download and install it from git-scm.com.

Getting Started

1. Clone the Repository

   Clone the repository to your local machine using the following command:

   ```sh git clone https://github.com/VihaanPhal/stockLearn.git ```

2. Navigate to the Project Directory

   Navigate to the project directory:

   ```sh cd stockLearn ```

3. Switch to the signup Branch

   Checkout the signup branch to get the latest frontend code:

   ```sh git checkout signup ```

Running the Frontend

1. Navigate to the frontend Directory

   Navigate to the frontend directory:

   ```sh cd frontend ```

2. Install Dependencies

   Install the required dependencies using npm:

   ```sh npm install ```

3. Run the Development Server

   Start the development server:

   ```sh npm run dev ```

   You should see output similar to the following, indicating that the server is running:

   ```sh VITE v2.x.x ready in x.xs

   ➜ Local: http://localhost:3000/ ➜ Network: use --host to expose ```

4. Open the Application in Your Browser

   Open your browser and navigate to http://localhost:3000 to view the application.

Contributing

To contribute to this project, follow these steps:

1. Create a New Branch

   Create a new branch for your feature or bugfix:

   ```sh git checkout -b feature-name ```

2. Make Your Changes

   Make your changes to the codebase.

3. Commit Your Changes

   Commit your changes with a meaningful commit message:

   ```sh git commit -m "Description of your changes" ```

4. Push to the Branch

   Push your changes to your branch:

   ```sh git push origin feature-name ```

5. Create a Pull Request

   Create a pull request to merge your changes into the main branch.

License

This project is licensed under the MIT License. See the LICENSE file for details.