Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/impooya/cms-site-fa

cms panel website
https://github.com/impooya/cms-site-fa

axios jsx mysql nodejs react-query reactjs routes

Last synced: 3 months ago
JSON representation

cms panel website

Awesome Lists containing this project

README

        

## Educational CMS Project in Persian (Farsi) 🤖

### About

This project is based on the educational React course by SabzLearn. The backend has been provided exclusively by the SabzLearn Academy website, and the frontend has been developed by me. It is connected to a MySQL database and a Node.js backend. It has some issues that will be fixed in the future. This project will not be deployed! I designed it only for practice and to challenge myself.

## Technologies Used

1. - A fast development build tool for modern web projects.
2. - A high-level, interpreted programming language.
3. - A JavaScript library for building user interfaces.
4. - A standard library for routing in React applications.
5. - An open-source relational database management system.
6. - A JavaScript runtime built on Chrome's V8 JavaScript engine.
7. - A library for fetching, caching, and updating data in React applications.
8. - A promise-based HTTP client for the browser and Node.js.
9. - A utility-first CSS framework for rapid UI development.

## Project Setup Instructions

Follow these steps to set up and run the project on your local machine.

### 1. Prerequisites

Make sure to install the following prerequisites:

- **Node.js**:

- Download and install Node.js from [nodejs.org](https://nodejs.org/).

- **XAMPP**:
- Download and install XAMPP from [apachefriends.org](https://www.apachefriends.org/).

### 2. Clone the Repository

Clone the project repository from GitHub:

```bash
git clone https://github.com/impooya/cms-site-fa.git
cd cms-app
```

### 3.Install Node.js Dependencies

install the Node.js dependencies

```bash
npm install
```

Navigate to the backend directory and install the Node.js dependencies:

```bash
cd cms-app/backend
npm install
```

### 4. Set Up the Database

To set up the MySQL database for this project, follow these steps:

1. Open **XAMPP** and start the **Apache** and **MySQL** services.
2. Open your browser and navigate to [http://localhost/phpmyadmin](http://localhost/phpmyadmin).
3. Create a new database named **`sabzlearn_shop`**.
4. Go to the **"Import"** tab and upload the `sabzlearn_shop.sql` file located in `cms-app/backend/database`.

### 6. Run the Backend and Frontend

To run the project, open two terminal windows or use a terminal multiplexer.

#### Backend:

1. Navigate to the backend directory:

```bash
cd cms-app/backend
```

2. Start the backend server with the following command:

```bash
node server.js
```

#### Frontend:

1. In another terminal, navigate to the project root (where `vite.config.js` is located):

```bash
cd cms-app
```

2. Run the frontend development server:

```bash
npm run dev
#or
vite
```

## Coming Soon...

This project is not responsive for mobile and tablet and has limited features; it is somewhat a simulation of a real project. Updates will be coming soon.