whflima/contacts-react-app

Contacts application that enables users to browse and manage their contact list across different devices easily.

โ˜… 0Forks 0TypeScriptGitHub โ†—Compare

Project website โ†—

ag-grid-reactant-designreacttypescript

README

Welcome to Contacts App ๐Ÿ‘‹

Contacts application that enables users to browse and manage their contact list across different devices easily.

๐Ÿ  Homepage

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.

contacts-app

๐Ÿ“ 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:

git clone https://github.com/whflima/contacts-react-app.git
  1. Navigate to the project folder

Run the following command to move into the project folder:

cd contacts-react-app
  1. Install dependencies

Run the following command to install the required dependencies:

npm install --force

It will install all the necessary packages listed in the package.json file.

  1. Start application

Run the following command to start the development server:

npm run start

Open http://localhost:3000 to view it in the browser.

Author

๐Ÿ‘ค Welisson Lima

Show your support

Give a โญ๏ธ if this project helped you!


Contributors

whflima

Issues