The Qamous Frontend is the client-side component of the Qamous application, a platform for users to contribute and explore definitions of Arabic and Franco-Arabic words. The frontend is responsible for providing a user-friendly interface for user authentication, word, and definition management, as well as user interactions such as liking, disliking, and reporting definitions.
**If you're looking for the Back-End, find it here.
- React.js: A JavaScript library for building user interfaces.
- TypeScript: A statically typed superset of JavaScript that adds optional types.
- SCSS (SASS): A preprocessor scripting language that is interpreted or compiled into Cascading Style Sheets (CSS).
- PostCSS: A tool for transforming CSS with JavaScript plugins.
- React Query: A library for managing, caching, and syncing server state; used for http request.
- i18next: An internationalization-framework for managing the English and Arabic translations.
- Clone the repository:
git clone <repository-url> - Navigate to the project directory:
cd urban-dictionary-ar-frontend - Install dependencies:
npm install - Configure environment variables:
- Create a
.envfile in the root directory. - Define the following environment variables:
REACT_APP_API_URL=<your-backend-api-url>
- Create a
- Start the server:
npm start
- User Registration and Login
- Word and Definition Management
- User Interactions (Liking, Disliking, Reporting Definitions)
- User Profile Management
This project is licensed under the Mozilla Public License Version 2.0 - see the LICENSE file for details.
