An open API service indexing awesome lists of open source software.

https://github.com/chandan8018/chaintechassignment


https://github.com/chandan8018/chaintechassignment

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# ChainTech Assignment

Welcome to the ChainTech Assignment project! This project is designed to showcase a web application built with modern technologies including React, Redux, Tailwind CSS, and more. The application features user authentication, a private route system, and a beautiful, responsive design.

## Table of Contents

- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Folder Structure](#folder-structure)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)

## Features

- **User Authentication**: Secure login and registration with Redux state management.
- **Private Routes**: Protected routes that are accessible only to authenticated users.
- **Responsive Design**: Mobile-first design using Tailwind CSS.
- **Interactive UI**: Smooth animations using Framer Motion.
- **Reusable Components**: Modular and reusable React components.

## Demo

![Home Page](./src/assets/home.png)
---
![Sign Up](./src/assets/signup.png)
---
![Sign In](./src/assets/signin.png)
---
![Update](./src/assets/update.png)

## Installation

To run this project locally, follow these steps:

1. **Clone the repository**:
```sh
git clone https://github.com/yourusername/chaintechassignment.git
cd chaintechassignment
```

2. **Install dependencies**:
```sh
npm install
```

3. **Start the development server**:
```sh
npm run dev
```

## Usage

Once the server is running, you can visit the application at `http://localhost:3000`. You can navigate through different pages such as Home, Services, About, Contact, Sign In, and Sign Up. Authenticated users can access the Dashboard.

### Home Page

The Home Page is designed to welcome users with an attractive gradient background and interactive elements. It includes links to services and contact pages.

### Sign In / Sign Up

Users can sign in or register for a new account. These forms handle user input and manage state using Redux.

### Dashboard

Accessible only to authenticated users, the Dashboard displays user-specific information and actions.

## Folder Structure

```sh
.
├── public
├── src
│ ├── components
│ │ ├── footer
│ │ │ └── FooterComp.jsx
│ │ ├── header
│ │ │ └── Header.jsx
│ │ ├── privateroute
│ │ │ └── PrivateRoute.jsx
│ │ ├── ui
│ │ │ └── Various UI Components
│ ├── pages
│ │ ├── About.jsx
│ │ ├── Contact.jsx
│ │ ├── Dashboard.jsx
│ │ ├── Home.jsx
│ │ ├── Service.jsx
│ │ ├── SignIn.jsx
│ │ └── SignUp.jsx
│ ├── redux
│ │ ├── theme
│ │ │ └── themeSlice.js
│ │ └── user
│ │ └── userSlice.js
│ ├── App.jsx
│ ├── main.jsx
│ └── index.css
├── .eslintrc.js
├── .gitignore
├── package.json
├── README.md
└── tailwind.config.js