https://github.com/tanmay-312/miniproject-sem6-3
A modern, responsive dog rescue website built with React for the frontend and Golang for the backend. This web application enables users to view, search, and adopt rescue dogs. It features a user-friendly interface, dynamic routing, and efficient API integration for a seamless user experience.
https://github.com/tanmay-312/miniproject-sem6-3
dog-rescue full-stack fullstack-development golang react tailwindcss website
Last synced: 3 months ago
JSON representation
A modern, responsive dog rescue website built with React for the frontend and Golang for the backend. This web application enables users to view, search, and adopt rescue dogs. It features a user-friendly interface, dynamic routing, and efficient API integration for a seamless user experience.
- Host: GitHub
- URL: https://github.com/tanmay-312/miniproject-sem6-3
- Owner: Tanmay-312
- Created: 2024-04-21T06:57:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T06:14:36.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T08:49:11.413Z (over 1 year ago)
- Topics: dog-rescue, full-stack, fullstack-development, golang, react, tailwindcss, website
- Language: JavaScript
- Homepage:
- Size: 2.99 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Name
## Overview
This project is a web application built using React for the frontend and Golang for the backend. The application leverages a variety of tools and libraries to create a modern, responsive, and performant user experience.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Technologies](#technologies)
- [Features](#features)
- [Contributing](#contributing)
## Installation
### Prerequisites
Before you begin, ensure you have the following installed:
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [Go](https://golang.org/)
### Frontend
1. Clone the repository:
```bash
git clone https://github.com/Tanmay-312/MiniProject-sem6-3.git
cd MiniProject-sem6-3/client
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm start
```
### Backend
1. Navigate to the backend directory:
```bash
cd ../server
```
2. Build the Go application:
```bash
go build
```
3. Run the Go server:
```bash
./your-go-app
```
## Usage
After completing the installation steps, you can access the frontend of the application at `http://localhost:3000` and the backend API at `http://localhost:your-backend-port`.
## Technologies
### Frontend
- **React**: A JavaScript library for building user interfaces.
- **React DOM**: Serves as the entry point to the DOM and server renderers for React.
- **React Router DOM**: Enables dynamic routing in a React web application.
- **React Scripts**: Scripts and configuration used by Create React App.
- **Axios**: A promise-based HTTP client for the browser and Node.js.
- **Tailwind CSS**: A utility-first CSS framework for rapidly building custom designs.
- **PostCSS**: A tool for transforming CSS with JavaScript plugins.
- **Autoprefixer**: A PostCSS plugin to parse CSS and add vendor prefixes to CSS rules.
- **Web Vitals**: A set of metrics to measure the quality of user experience on the web.
### Backend
- **Golang (Go)**: A statically typed, compiled programming language designed for building scalable and maintainable applications.
## Features
- **Responsive Design**: Utilizes Tailwind CSS for a fully responsive layout.
- **Routing**: Implemented with React Router for dynamic page navigation.
- **API Integration**: Uses Axios to interact with the backend API.
- **Performance**: Optimized with Web Vitals to ensure a high-quality user experience.
- **Scalability**: Backend built with Go for efficient performance and scalability.
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/your-feature-name`).
5. Open a pull request.
---
Feel free to customize this README file further to fit the specific needs and details of your project.