A brief description of your project goes here.
Before you begin, make sure you have the following requirements installed on your local machine:
- Node.js
- npm or yarn
- Docker
To set up the project on your local machine, follow these steps
- Clone the repository to your local machine:
git clone https://github.com/marouaneXan/project-name.git
- Navigate to the project directory:
cd project-name
- Install the project dependencies:
or
npm install
yarn install
- Build the project:
or
npm run build
yarn build
- Run the project in development mode:
or
npm run dev
yarn dev
To use the project, follow these steps:
- Run the project in development mode (see above).
- Open your web browser and navigate to http://localhost:5000.
To deploy the project, follow these steps:
- Build the project for production:
or
npm run build
yarn build
- Run the production build in a Docker container:
docker-compose up -d
- React
- TypeScript
- Express
- Docker
- GraphQL
If you want to contribute to the project, please follow the Contributing Guidelines.
This project is licensed under the MIT License.