https://github.com/whflima/contacts-react-app
Contacts application that enables users to browse and manage their contact list across different devices easily.
https://github.com/whflima/contacts-react-app
ag-grid-react ant-design react typescript
Last synced: about 2 months ago
JSON representation
Contacts application that enables users to browse and manage their contact list across different devices easily.
- Host: GitHub
- URL: https://github.com/whflima/contacts-react-app
- Owner: whflima
- Created: 2024-12-08T09:29:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-09T05:33:07.000Z (over 1 year ago)
- Last Synced: 2025-02-14T00:42:16.348Z (over 1 year ago)
- Topics: ag-grid-react, ant-design, react, typescript
- Language: TypeScript
- Homepage: https://whflima.github.io/contacts-react-app/
- Size: 14.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to Contacts App 👋
> Contacts application that enables users to browse and manage their contact list across different devices easily.
### 🏠 [Homepage](https://whflima.github.io/contacts-react-app/)
## Video demo
Watch the video below for a quick demo of how the application works:
> **Note:** The video may take some time to load. Please be patient.
## 📁 Project Structure
```
.
├── src/components # Contains all reusable UI components.
├── src/constant # Stores constant values like status codes, app-wide static configurations, or messages
├── src/interfaces # Defines TypeScript interfaces and types used throughout the app for strong typing
├── src/locales # Includes localization (i18n) files for supporting multiple languages
├── src/providers # Houses context providers for managing app-wide state.
├── src/services # Contains API service handlers.
├── src/utils # Contains utility/helper functions used across the app.
├── src/App.tsx # Root component that sets up routing and integrates major providers or layout
├── src/index.tsx # Entry point of the React app where the app is rendered to the DOM
├── .gitignore # Specifies intentionally untracked files to ignore in Git.
```
## 🛠️ Technologies Used
- Node.js (v14.0 or higher)
- npm (v10.4.0 or higher)
## 📦 Setup & Run Locally
1. **Clone the repository**
Run the following command to clone this project to your local machine:
```sh
git clone https://github.com/whflima/contacts-react-app.git
```
2. **Navigate to the project folder**
Run the following command to move into the project folder:
```sh
cd contacts-react-app
```
3. **Install dependencies**
Run the following command to install the required dependencies:
```sh
npm install --force
```
It will install all the necessary packages listed in the package.json file.
4. **Start application**
Run the following command to start the development server:
```sh
npm run start
```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Author
👤 **Welisson Lima**
* Github: [@whflima](https://github.com/whflima)
* LinkedIn: [@https:\/\/www.linkedin.com\/in\/welisson-lima\/](https://linkedin.com/in/welisson-lima)
## Show your support
Give a ⭐️ if this project helped you!
***