Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
francisojeah authored Sep 7, 2024
1 parent 64cd398 commit ac253ed
Showing 1 changed file with 31 additions and 22 deletions.
53 changes: 31 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,39 @@
# React + TypeScript + Vite
## Modern Logistics - Corporate Website

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
### Overview

Currently, two official plugins are available:
**Modern Logistics** is a corporate website for **Modern Logistics Services (MLS)**, showcasing logistics and supply chain solutions. Built with React, TypeScript, Vite, Chakra UI, and Tailwind CSS, it offers a responsive and user-friendly experience.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
### Technologies Used

## Expanding the ESLint configuration
- **React** with **TypeScript**
- **Vite** for fast development
- **Chakra UI** and **Tailwind CSS** for styling

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
### Getting Started

- Configure the top-level `parserOptions` property like this:
1. **Clone the repository:**

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```
```bash
git clone https://github.com/francisojeah/mls-website.git
cd mls-website
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
2. **Install dependencies:**

```bash
npm install
```

3. **Run the development server:**

```bash
npm run dev
```

The website will be available at `http://localhost:3000`.

### Links

- [Live Site](https://modern-logistics-services.netlify.app/)
- [GitHub Repository](https://github.com/francisojeah/mls-website)

0 comments on commit ac253ed

Please sign in to comment.