/AL-MADA-

"This project is a web application built using React and TypeScript on the frontend, and Express on the backend. It utilizes Docker to containerize the application, making it easy to deploy and run in any environment.

Primary LanguageTypeScript

Project Name

A brief description of your project goes here.

Prerequisites

Before you begin, make sure you have the following requirements installed on your local machine:

  • Node.js
  • npm or yarn
  • Docker

Installation

To set up the project on your local machine, follow these steps

  1. Clone the repository to your local machine:
    git clone https://github.com/marouaneXan/project-name.git
  2. Navigate to the project directory:
    cd project-name
  3. Install the project dependencies:
    npm install
    or
    yarn install
  4. Build the project:
    npm run build
    or
    yarn build
  5. Run the project in development mode:
    npm run dev
    or
    yarn dev

Usage

To use the project, follow these steps:

  1. Run the project in development mode (see above).
  2. Open your web browser and navigate to http://localhost:5000.

Deployment

To deploy the project, follow these steps:

  1. Build the project for production:
    npm run build
    or
    yarn build
  2. Run the production build in a Docker container:
    docker-compose up -d

Technologies Used

  • React
  • TypeScript
  • Express
  • Docker
  • GraphQL

Contributing

If you want to contribute to the project, please follow the Contributing Guidelines.

License

This project is licensed under the MIT License.