1
1
mirror of https://github.com/theoludwig/theoludwig.git synced 2024-11-03 20:11:30 +01:00
.profile/CONTRIBUTING.md

1.6 KiB

💡 Contributing

Thanks a lot for your interest in contributing to divlo.fr! 🎉

Types of contributions

  • Reporting a bug.
  • Suggest a new feature idea.
  • Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
  • Improve structure/format/performance/refactor/tests of the code.

Pull Requests

  • Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time.

  • Ensure your code respect linting.

  • Make sure your code passes the tests.

If you're adding new features to divlo.fr, please include tests.

Commits

The commit message guidelines respect @commitlint/config-conventional and Semantic Versioning for releases.

Getting Started

Open in Gitpod

Prerequisites

Installation

# Clone the repository
git clone https://github.com/Divlo/Divlo.git

# Go to the project root
cd Divlo

# Configure environment variables
cp .env.example .env

# Install
npm install

Local Development environment

# Run website
npm run dev

Production environment with Docker

# Setup and run all the services for you
docker compose up --build

Services started

  • website: http://127.0.0.1:3000