REACT-DEMO

Built with the tools and technologies:

Quick Links

• Overview
• Project Structure
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Project Roadmap
• Contributing
• License
• Acknowledgments

Overview

I created this website as my first React Demo Project

Project Structure

└── React-demo/
    ├── Iconjs.svg
    ├── components.json
    ├── index.html
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.js
    ├── react.svg
    ├── src
    │   ├── App.tsx
    │   ├── components
    │   ├── index.css
    │   ├── lib
    │   ├── main.tsx
    │   ├── styles.css
    │   └── vite-env.d.ts
    ├── tailwind.config.js
    ├── tsconfig.app.json
    ├── tsconfig.json
    ├── tsconfig.node.json
    └── vite.config.ts

Getting Started

Prerequisites

Before getting started with React-demo, ensure your runtime environment meets the following requirements:

• Programming Language: TypeScript
• Package Manager: npm

Installation

Install React-demo using one of the following methods:

Build from source:

1. Clone the React-demo repository:

git clone https://github.com/Devang-sharma609/React-demo

2. Navigate to the project directory:

cd React-demo

3. Install the project dependencies:

Using  

npm install

Usage

Run React-demo using the following command: Using  

npm run dev

Contributing

• 🐛 Report Issues: Submit bugs found or log feature requests for the React-demo project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Devang-sharma609/React-demo

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

License

This project is protected under the Apache License. For more details, refer to the LICENSE file.

Acknowledgments

All thanks to my batchmates who sufficed me with creative material for my inspiration.