Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ansaribrahim/tour-frontend

This project is a full-stack web application built with React.js for the frontend and Node.js for the backend. It's a user-centric platform where users can share and explore places around the world.
https://github.com/ansaribrahim/tour-frontend

css http javascript react redux validator

Last synced: 26 days ago
JSON representation

This project is a full-stack web application built with React.js for the frontend and Node.js for the backend. It's a user-centric platform where users can share and explore places around the world.

Awesome Lists containing this project

README

        


Tour App


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [👨‍💻 Fix Mate ](#-fix-mate-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Running the App](#running-the-app)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# [ 👨‍💻 Tour App ]

**Tour App** This repository contains the frontend code for the "Places in Tamil Nadu" web application. The application is built with React.js and provides a user-friendly interface for exploring and sharing places in Tamil Nadu..

## Responsive View

TourApp Image ![Screenshot 2024-02-09 at 12 49 20 PM (2)](https://github.com/AnsarIbrahim/tour-frontend/assets/117971223/90a8d828-beb2-49bc-864e-e5e1d985106e)

## Live Link

> - [Live Link](https://placestamilnadu.netlify.app)

## Link to Back End

> - [Base Url](https://walrus-app-g9c8k.ondigitalocean.app/api/)

> - API Endpoints

- api/users
- api/places
> - [API Documentation](https://documenter.getpostman.com/view/27096897/2s9YyzcdBM)

> - [Link to Back-end Repository](https://github.com/AnsarIbrahim/tour-backend)

## 🛠 Built With

### Tech Stack

Client

### Key Features

The key features of this project include.

- **Add Places**
- **See Places**
- **Signup**
- **Login**
- **See via Map**
- **Delete a Places**

(back to top)

## 💻 Getting Started

> - To get a local copy up and running, follow these steps.

### Prerequisites

Before you begin, make sure you have the following installed on your machine:

- [x] A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode [here](https://code.visualstudio.com/download), Sublime [here](https://www.sublimetext.com/3), and Atom [here](https://atom.io/).
- [x] Git: You can download Git [here](https://git-scm.com/downloads).
- [x] Node.js: You can download Node.js [here](https://nodejs.org/en/download/).

> - Version Requirements:

```
react > 16.3.2
```

### Setup

> - To set up this project locally:

1. Open the terminal in VScode.
2. Navigate to the directory where you want to clone the copy of this repository.
3. Create a new directory [optional].
4. Clone the repository by running the following command:

```sh
git clone https://github.com/ansaribrahim/tour-frontend.git
```

5. Navigate into the cloned repository:

```sh
cd tour-frontend
```

### Installation

1. Install the required dependencies by running the following command:

```sh
npm install
```

```sh
npm install react-redux
```

```sh
npm install react-router-dom
```

```sh
npm install @reduxjs/toolkit
```

### Running the App

> - To run the application, run the following command:

```sh
npm start
```

### Run tests

> - To run the Stylelint checker, run the following command:

```sh
npm install
```

```sh
npx stylelint "**/*.{css,scss}"
```

> - To run the ESlint checker, run the following command:

```sh
npx eslint "**/*.{js,jsx}"
```

> - This will start the React development server and you can access the application by visiting http://localhost:3000 in your web browser.

(back to top)

## 👥 Authors

The collaborators of this project.

👤 **Ansar Ibrahim**

- [GitHub](https://github.com/AnsarIbrahim)
- [LinkedIn](https://linkedin.com/in/ansar-ibrahim/)
- [Twitter](https://twitter.com/ansaradheeb)

(back to top)

## 🔭 Future Features

- [ ] **Create Live Location**
- [ ] **Add Admin Role**

(back to top)

## 🤝 Contributing

> - Contributions, issues, and feature requests are welcome!

> - Feel free to check the [issues page](../../issues/).

(back to top)

## 💖 Show your support

> - Give a ⭐️, if you like this project!

(back to top)

## 🙏 Acknowledgments

> - I would like to thank EveryOne.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)