Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tusho7/local-recommendations-front
https://github.com/tusho7/local-recommendations-front
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tusho7/local-recommendations-front
- Owner: Tusho7
- Created: 2024-07-03T11:15:52.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T06:14:53.000Z (7 months ago)
- Last Synced: 2024-07-10T08:02:53.369Z (7 months ago)
- Language: TypeScript
- Size: 203 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Local Recommendation Platform
### Table of Contents
- [Prerequisites](#prerequisites)
- [Tech Stack](#Tecg-Stack)
- [Getting Started](#Getting-Started)
- [Project Structure](#Project-Structure)
- [Deployment](#Deployment)
#
### Prerequisites
- 
Node JS @16.X and up
- 
npm @8 and up
#
### Tech Stack
- 
React @ 18.3.1 - A JavaScript library for building user interfaces.
- 
TypeScript @ 5.2.2 - Typed superset of JavaScript.
- 
Tailwind CSS @ 3.4.4 - Utility-first CSS framework.
- 
Axios @ 1.7.2 - Promise based HTTP client for the browser and Node.js.
- 
ws @ 8.17.1 - Simple to use, blazing fast and thoroughly tested WebSocket client, server, and console for node.js.
- 
sweetalert @ 2.1.2 - A beautiful replacement for JavaScript's alert.
#
### Getting Started
1. First of all you need to clone app repository from Github :
```
git clone https://github.com/Tusho7/local-recommendations-front
```
2. Next step requires install all the dependencies.
```
npm install
```
3. To see project in action
```
npm run start
```
#
### Project Structure
```
src
├── assets # Static assets (images, fonts, etc.)
├── components # React components
├── contexts # Page contexts
├── dynamicIcons # Page icons
├── modals # Page modals
├── pages # Page components
├── plugins # Application plugins
├── services # Application services
├── types # Application interfaces
├── utils # Utility functions
├── App.tsx # Main application component
├── index.tsx # Entry point file
└── main.tsx # Main file for rendering React app
```
#
### Deployment
Before every deployment you need to create build file.
```
npm run build
```
after this you can use this file to deploy project on server.
### Assets: Contains static assets like images and fonts.
### Components: Reusable React components.
### Contexts: Context providers for managing global state.
### Modals: Modal components used in various pages.
### Pages: Page components representing different views in the app.
### Plugins: Plugins used within the application.
### Services: Service functions for API calls and other functionalities.
### Types: TypeScript interfaces and types.
### Utils: Utility functions and helpers.
### App.tsx: Main application component.
### Index.tsx: Entry point file for the React app.
### Main.tsx: Main file for rendering the React application.
###
This README template provides a clear structure and instructions for setting up and understanding your Local Recommendation's Platform Frontend project. Adjust the sections and details according to your specific project setup and requirements.